Type Alias WebsocketSendData<Connection, B>

Input for sending websocket data.

type WebsocketSendData<
    Connection extends BaseWebsocketConnection,
    B extends boolean,
> = {
    connection: Connection;
    event: LooseWebsocketEvent;
    expectResponse?: B;
    message: WebsocketSendDataMessage;
    persist?: boolean;
    responseHandler?: WebsocketResponseHandler;
}

Type Parameters

Connection extends BaseWebsocketConnection
B extends boolean

Index

Properties

connection event expectResponse? message persist? responseHandler?

Properties

connection

connection: Connection

The connection to send to.

event

event: LooseWebsocketEvent

The event to send to.

`Optional`expectResponse

expectResponse?: B

Whether or not a response is expected.

message

message: WebsocketSendDataMessage

The actual message to sent.

`Optional`persist

persist?: boolean

Whether or not the message should be persisted in the data source.

`Optional`responseHandler

responseHandler?: WebsocketResponseHandler

An optional handler for the response, if the implementation supports that. If not set and a response is expected, it gets emitted the default way.