Type alias RealtimeClientOptions

RealtimeClientOptions: {
    accessToken?: (() => Promise<string | null>);
    decode?: Function;
    encode?: Function;
    fetch?: Fetch;
    headers?: {
        [key: string]: string;
    };
    heartbeatCallback?: ((status: HeartbeatStatus) => void);
    heartbeatIntervalMs?: number;
    logLevel?: LogLevel;
    log_level?: LogLevel;
    logger?: Function;
    params?: {
        [key: string]: any;
    };
    reconnectAfterMs?: Function;
    timeout?: number;
    transport?: WebSocketLikeConstructor;
    worker?: boolean;
    workerUrl?: string;
}

Type declaration

  • Optional accessToken?: (() => Promise<string | null>)
      • (): Promise<string | null>
      • Returns Promise<string | null>

  • Optional decode?: Function
  • Optional encode?: Function
  • Optional fetch?: Fetch
  • Optional headers?: {
        [key: string]: string;
    }
    • [key: string]: string
  • Optional heartbeatCallback?: ((status: HeartbeatStatus) => void)
      • (status: HeartbeatStatus): void
      • Parameters

        • status: HeartbeatStatus

        Returns void

  • Optional heartbeatIntervalMs?: number
  • Optional logLevel?: LogLevel
  • Optional log_level?: LogLevel
  • Optional logger?: Function
  • Optional params?: {
        [key: string]: any;
    }
    • [key: string]: any
  • Optional reconnectAfterMs?: Function
  • Optional timeout?: number
  • Optional transport?: WebSocketLikeConstructor
  • Optional worker?: boolean
  • Optional workerUrl?: string

Generated using TypeDoc