Type Alias WebSocketAuthParams

Websocket auth parameters to use when setting up a websocket based on a host config

type WebSocketAuthParams = {
    headers?: Record<string, string>;
    pfxOptions?: PfxAuthOptions;
    queryParams?: Record<string, string>;
}

Index

Properties

headers? pfxOptions? queryParams?

Properties

`Optional`headers

headers?: Record<string, string>

`Optional`pfxOptions

pfxOptions?: PfxAuthOptions

`Optional`queryParams

queryParams?: Record<string, string>

The query parameters to add to the websocket URL