Interface ApiWsOptions<RequestCommandsT, QueryT>

interface ApiWsOptions<
    RequestCommandsT extends AnyCommands,
    QueryT extends AnyQuery,
> {
    onConnect?: WsApiConnectionChangeHandler<RequestCommandsT, QueryT>;
    onDisconnect?: WsApiConnectionChangeHandler<RequestCommandsT, QueryT>;
    onError?: WsApiErrorHandler<RequestCommandsT, QueryT>;
    onMessage?: WsApiMessageReceiptHandler<RequestCommandsT, QueryT>;
    requestValidationMode?: ValidationMode;
    responseValidationMode?: ValidationMode;
}

Type Parameters

RequestCommandsT extends AnyCommands
QueryT extends AnyQuery

Index

Properties

onConnect? onDisconnect? onError? onMessage? requestValidationMode? responseValidationMode?

Properties

`Optional`onConnect

onConnect?: WsApiConnectionChangeHandler<RequestCommandsT, QueryT>

`Optional`onDisconnect

onDisconnect?: WsApiConnectionChangeHandler<RequestCommandsT, QueryT>

`Optional`onError

onError?: WsApiErrorHandler<RequestCommandsT, QueryT>

`Optional`onMessage

onMessage?: WsApiMessageReceiptHandler<RequestCommandsT, QueryT>

`Optional`requestValidationMode

requestValidationMode?: ValidationMode

Override the configured request validation mode.

See

setDefaultRequestValidationMode

`Optional`responseValidationMode

responseValidationMode?: ValidationMode

Override the configured response validation mode.

Hard validation is always performed on responses statuses, regardless of this setting.

See

setDefaultResponseValidationMode