Interface BackendWebSocketOptions

interface BackendWebSocketOptions {
    auth: {
        token: string;
    };
    bearerToken?: string;
    path?: string;
    transportOptions?: {
        [key: string]: any;
    };
    transports: string[];
}

Properties

auth bearerToken? path? transportOptions? transports

Properties

auth

auth: {
    token: string;
}

Authentication parameters

Type declaration

  • token: string

Optional bearerToken

bearerToken?: string

The bearer token to use in the websocket connection

Optional path

path?: string

The path to connect to the websocket server

Optional transportOptions

transportOptions?: {
    [key: string]: any;
}

Additional options to pass to the websocket transport

Type declaration

  • [key: string]: any

transports

transports: string[]

The websocket transports to use

Settings

Member Visibility

Theme

On This Page

authbearerTokenpathtransportOptionstransports