Class SessionManager

Description

Support legacy, and modern session

Hierarchy

SessionManager

Index

Constructors

Properties

#auth client path save type

Accessors

Methods

init registerAdapter remove useAuth

Constructors

constructor

new SessionManager(path: string, type?: SessionType): SessionManager
Parameters
- path: string
  
  Session Path
- type: SessionType = 'folder'
  
  Session store type
Returns SessionManager
- Defined in src/utils/sessionManager.ts:31

Properties

`Private` #auth

#auth: AuthenticationState

client

client: Client

`Private` path

path: string

Session Path

save

save: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- Save current state.
  
  Returns
  
  Returns void | Promise<void>

`Private` type

type: SessionType = 'folder'

Session store type

Accessors

auth

get auth(): AuthenticationState
Get current authentication state.

Returns

Returns AuthenticationState
- Defined in src/utils/sessionManager.ts:157

Methods

init

init(): Promise<SessionManager>
Initialize session manager.

Returns

Returns Promise<SessionManager>
- Defined in src/utils/sessionManager.ts:46

registerAdapter

registerAdapter<T>(adapter: Adapter<T>, args: T): Promise<SessionManager>
Register your favourite adapter.

Returns
Type Parameters
- T
Parameters
- adapter: Adapter<T>
  
  The adapter.
- args: T
  
  Adapter's args.
Returns Promise<SessionManager>
- Defined in src/utils/sessionManager.ts:99

remove

remove(): Promise<boolean>
Remove current session folder/path

Returns

Returns Promise<boolean>
- Defined in src/utils/sessionManager.ts:120

useAuth

useAuth(auth: AuthenticationState): boolean
Use external authentication state.

Returns
Parameters
- auth: AuthenticationState
  
  Authentication state data.
Returns boolean
- Defined in src/utils/sessionManager.ts:146

Generated using TypeDoc