Class SessionManager

Hierarchy

CreateDestroyStartStop
- SessionManager

Index

Constructors

Properties

[initLock] db expiry? keyRing logger sessionsDbPath

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Methods

addEventListener createToken destroy dispatchEvent removeEventListener resetKey setupKey start stop verifyToken createSessionManager

Constructors

constructor

new SessionManager(__namedParameters): SessionManager
Parameters
- __namedParameters: {
      db: DB;
      expiry?: number;
      keyRing: KeyRing;
      logger: Logger;
  }
  - db: DB
  - Optional expiry?: number
  - keyRing: KeyRing
  - logger: Logger
Returns SessionManager
Inherited from CreateDestroyStartStop.constructor
- Defined in src/sessions/SessionManager.ts:63

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` db

db: DB

`Optional` `Readonly` expiry

expiry?: number

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Protected` sessionsDbPath

sessionsDbPath: readonly (string | Buffer)[] = ...

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

createToken

createToken(expiry?, tran?): Promise<SessionToken>
Creates session token This is not blocked by key reset
Parameters
- expiry: undefined | number = ...
  
  Seconds from now or default
- Optional tran: DBTransaction
Returns Promise<SessionToken>
- Defined in src/sessions/SessionManager.ts:117

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/sessions/SessionManager.ts:98

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

resetKey

resetKey(tran?): Promise<void>
Parameters
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/sessions/SessionManager.ts:104

`Protected` setupKey

setupKey(): Promise<Buffer>
Returns Promise<Buffer>
- Defined in src/sessions/SessionManager.ts:148

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from CreateDestroyStartStop.start
- Defined in src/sessions/SessionManager.ts:80

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/sessions/SessionManager.ts:93

verifyToken

verifyToken(token, tran?): Promise<boolean>
Parameters
- token: SessionToken
- Optional tran: DBTransaction
Returns Promise<boolean>
- Defined in src/sessions/SessionManager.ts:134

`Static` createSessionManager

createSessionManager(__namedParameters): Promise<SessionManager>
Parameters
- __namedParameters: {
      db: DB;
      expiry?: number;
      fresh?: boolean;
      keyRing: KeyRing;
      logger?: Logger;
  }
  - db: DB
  - Optional expiry?: number
  - Optional fresh?: boolean
  - keyRing: KeyRing
  - Optional logger?: Logger
Returns Promise<SessionManager>
- Defined in src/sessions/SessionManager.ts:31

Generated using TypeDoc