hydrated-ws
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IWaterfallOptions

Index

Properties

Properties

Optional connectionTimeout

connectionTimeout: number

Time in ms before connection attempt timeout default to 5000

Optional emitClose

emitClose: boolean

Emit e close event before reconnecting default to false

Optional factory

factory: (url: string, protocols?: string | string[]) => WebSocket

Websocket factory

Type declaration

    • (url: string, protocols?: string | string[]): WebSocket

    • Parameters

      • url: string
      • Optional protocols: string | string[]

      Returns WebSocket

Optional retryPolicy

retryPolicy: (attempt: number, ws: Waterfall) => number

Retry policy function default to exponentialTruncatedBackoff

Type declaration

    • Parameters

      Returns number

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Protected property
  • Protected method
  • Static property
  • Static method

Generated using TypeDoc