Class TokenAuthManager

Hierarchy (View Summary)

AuthManagerBase<TokenAuthData | null>
- TokenAuthManager

Index

Constructors

Properties

_logger listeners

Accessors

isAuthenticated

Methods

authenticate authenticateRequest backup clear emit off on once removeAllListeners socketOptions

Constructors

constructor

new TokenAuthManager(baseUrl: string, logger: Logger): TokenAuthManager
Parameters
- baseUrl: string
- logger: Logger
Returns TokenAuthManager
Overrides AuthManagerBase.constructor
- Defined in lib/AuthManager/TokenAuthManager.ts:27

Properties

`Protected`_logger

_logger: Logger

`Protected`listeners

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

Accessors

isAuthenticated

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

Methods

authenticate

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

authenticateRequest

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

backup

backup(): Promise<null | { refreshToken: string; token: string }>
Get the current authentication data to persist it

Returns Promise<null | { refreshToken: string; token: string }>
Overrides AuthManagerBase.backup
- Defined in lib/AuthManager/TokenAuthManager.ts:36

clear

clear(): void
Returns void
Overrides AuthManagerBase.clear
- Defined in lib/AuthManager/TokenAuthManager.ts:59

`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 AuthManagerBase.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 AuthManagerBase.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 AuthManagerBase.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 AuthManagerBase.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 AuthManagerBase.removeAllListeners
- Defined in lib/TypedEventEmitter.ts:56

socketOptions

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