Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OpenOptions<Ctx>

Connection options supplied to Client.open

The only required option is fetchConnectionMetadata (falling back to fetchToken), all others are optional and will use defaults.

TODO(lhchavez): Once the migration is done, drop fetchToken and only use fetchConnectionMetadata.

Type parameters

  • Ctx

Hierarchy

  • Partial<ConnectOptions<Ctx>>
    • OpenOptions

Index

Properties

Optional WebSocketClass

WebSocketClass: typeof WebSocket

context

context: Ctx

fetchConnectionMetadata

fetchConnectionMetadata: (abortSignal: AbortSignal) => Promise<FetchConnectionMetadataResult>

Type declaration

Optional fetchToken

fetchToken: (abortSignal: AbortSignal) => Promise<{ aborted: true; token: null } | { aborted: false; token: string }>

Type declaration

    • (abortSignal: AbortSignal): Promise<{ aborted: true; token: null } | { aborted: false; token: string }>
    • Parameters

      • abortSignal: AbortSignal

      Returns Promise<{ aborted: true; token: null } | { aborted: false; token: string }>

timeout

timeout: number | null

Optional urlOptions

urlOptions: UrlOptions

Generated using TypeDoc