Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OpenOptions<Ctx>

Connection options supplied to Client.open

The only required option is fetchConnectionMetadata, all others are optional and will use defaults.

Type parameters

  • Ctx

Hierarchy

  • Partial<ConnectOptions<Ctx>>
    • OpenOptions

Index

Properties

Methods

Properties

Optional WebSocketClass

WebSocketClass?: { CLOSED: number; CLOSING: number; CONNECTING: number; OPEN: number; prototype: WebSocket }

Type declaration

  • Readonly CLOSED: number
  • Readonly CLOSING: number
  • Readonly CONNECTING: number
  • Readonly OPEN: number
  • prototype: WebSocket

context

context: Ctx

Optional pollingHost

pollingHost?: string

Optional reuseConnectionMetadata

reuseConnectionMetadata?: boolean

Optional timeout

timeout?: null | number

Optional urlOptions

urlOptions?: UrlOptions

Methods

fetchConnectionMetadata

Generated using TypeDoc