Class Session

Hierarchy

  • CreateDestroyStartStop
    • Session

Constructors

constructor

Properties

[initLock] fs logger sessionTokenPath

Accessors

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

Methods

addEventListener destroy dispatchEvent readToken removeEventListener start stop writeToken createSession

Constructors

constructor

  • Parameters

    • __namedParameters: {
          fs: FileSystem;
          logger: Logger;
          sessionTokenPath: string;
      }
      • fs: FileSystem
      • logger: Logger
      • sessionTokenPath: string

    Returns Session

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected fs

fs: FileSystem

Protected logger

logger: Logger

Readonly sessionTokenPath

sessionTokenPath: string

Accessors

[destroyed]

  • get [destroyed](): boolean

  • Returns boolean

[eventHandled]

  • get [eventHandled](): ReadonlyWeakSet<Event>

  • Returns ReadonlyWeakSet<Event>

[eventHandlers]

  • get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>

  • Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

  • get [eventTarget](): EventTarget

  • Returns EventTarget

[handleEventError]

  • get [handleEventError](): ((evt) => void)

  • Returns ((evt) => void)

      • (evt): void

      • Parameters

        • evt: EventError

        Returns void

[running]

  • get [running](): boolean

  • Returns boolean

[statusP]

  • get [statusP](): Promise<Status>

  • Returns Promise<Status>

[status]

  • get [status](): Status

  • Returns Status

Methods

addEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

destroy

  • Returns Promise<void>

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

readToken

removeEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

start

  • Parameters

    • __namedParameters: {
          fresh?: boolean;
          sessionToken?: SessionToken;
      } = {}
      • Optional fresh?: boolean
      • Optional sessionToken?: SessionToken

    Returns Promise<void>

stop

writeToken

Static createSession

  • Parameters

    • __namedParameters: {
          fresh?: boolean;
          fs?: FileSystem;
          logger?: Logger;
          sessionToken?: SessionToken;
          sessionTokenPath: string;
      }
      • Optional fresh?: boolean
      • Optional fs?: FileSystem
      • Optional logger?: Logger
      • Optional sessionToken?: SessionToken
      • sessionTokenPath: string

    Returns Promise<Session>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc