Class CookieAuthManager

Hierarchy (View Summary)

AuthManagerBase<undefined>
- CookieAuthManager

Index

Constructors

Properties

_logger listeners

Accessors

isAuthenticated

Methods

authenticate authenticateRequest backup clear emit off on once removeAllListeners socketOptions

Constructors

constructor

new CookieAuthManager(logger: Logger): CookieAuthManager
Parameters
- logger: Logger
Returns CookieAuthManager
Inherited from AuthManagerBase.constructor
- Defined in lib/AuthManager/AuthManagerBase.ts:11

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/CookieAuthManager.ts:20

Methods

authenticate

authenticate(): Promise<void>
For cookie authentication, there is no way to detect if the user is authenticated or not, except when a call to API was successful. So the REST client will set this property to true.

Returns Promise<void>
Overrides AuthManagerBase.authenticate
- Defined in lib/AuthManager/CookieAuthManager.ts:10

authenticateRequest

authenticateRequest(options: RequestInit): Promise<RequestInit>
Parameters
- options: RequestInit
Returns Promise<RequestInit>
Overrides AuthManagerBase.authenticateRequest
- Defined in lib/AuthManager/CookieAuthManager.ts:28

backup

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

Returns Promise<undefined>
Overrides AuthManagerBase.backup
- Defined in lib/AuthManager/CookieAuthManager.ts:24

clear

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

`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>
Returns Promise<undefined>
Overrides AuthManagerBase.socketOptions
- Defined in lib/AuthManager/CookieAuthManager.ts:35