Class AuthManagerBase<AuthData>`Abstract`

Type Parameters

AuthData = never

Hierarchy (View Summary)

TypedEventEmitter<AuthManagerEvents>
- AuthManagerBase

Index

Constructors

Properties

_logger listeners

Accessors

isAuthenticated

Methods

authenticate authenticateRequest backup clear emit off on once removeAllListeners socketOptions

Constructors

constructor

new AuthManagerBase<AuthData = never>(logger: Logger): AuthManagerBase<AuthData>
Type Parameters
- AuthData = never
Parameters
- logger: Logger
Returns AuthManagerBase<AuthData>
Overrides TypedEventEmitter.constructor
- Defined in lib/AuthManager/AuthManagerBase.ts:11

Properties

`Protected`_logger

_logger: Logger

`Protected`listeners

listeners: { updated?: (data: boolean) => void[] } = {}

Accessors

`Abstract`isAuthenticated

get isAuthenticated(): boolean
Returns boolean
- Defined in lib/AuthManager/AuthManagerBase.ts:16

Methods

`Abstract`authenticate

authenticate(data: AuthData): Promise<void>
Restore authentication from the data that was previously backed up
Parameters
- data: AuthData
Returns Promise<void>
- Defined in lib/AuthManager/AuthManagerBase.ts:32

`Abstract`authenticateRequest

authenticateRequest(option: RequestInit): Promise<RequestInit>
Parameters
- option: RequestInit
Returns Promise<RequestInit>
- Defined in lib/AuthManager/AuthManagerBase.ts:18

`Abstract`backup

backup(): Promise<AuthData>
Get the current authentication data to persist it

Returns Promise<AuthData>
- Defined in lib/AuthManager/AuthManagerBase.ts:26

`Abstract`clear

clear(): void
Returns void
- Defined in lib/AuthManager/AuthManagerBase.ts:34

`Protected`emit

emit<T extends "updated">(event: T, data: AuthManagerEvents[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends "updated"
Parameters
- event: T
- data: AuthManagerEvents[T]
Returns void
Inherited from TypedEventEmitter.emit
- Defined in lib/TypedEventEmitter.ts:69

off

off<T extends "updated">(
event: T,
listener: (data: AuthManagerEvents[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends "updated"
Parameters
- event: T
- listener: (data: AuthManagerEvents[T]) => void
Returns void
Inherited from TypedEventEmitter.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends "updated">(
event: T,
listener: (data: AuthManagerEvents[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends "updated"
Parameters
- event: T
- listener: (data: AuthManagerEvents[T]) => void
Returns () => void
Inherited from TypedEventEmitter.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends "updated">(
event: T,
listener: (data: AuthManagerEvents[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends "updated"
Parameters
- event: T
- listener: (data: AuthManagerEvents[T]) => void
Returns () => void
Inherited from TypedEventEmitter.once
- Defined in lib/TypedEventEmitter.ts:32

removeAllListeners

removeAllListeners<T extends "updated">(event?: T): void
Remove all event listeners, optionally for a specific event
Type Parameters
- T extends "updated"
Parameters
- Optionalevent: T
Returns void
Inherited from TypedEventEmitter.removeAllListeners
- Defined in lib/TypedEventEmitter.ts:56

`Abstract`socketOptions

socketOptions(): Promise<undefined | ClientOptions>
Returns Promise<undefined | ClientOptions>
- Defined in lib/AuthManager/AuthManagerBase.ts:20