rest-vir - v2.2.0
    Preparing search index...

    Type Alias BaseWebSocketDefinition

    @rest-vir/api

    type BaseWebSocketDefinition = {
        clientMessage?: Shape;
        connectProtocol?: WebSocketConnectProtocolRequirement;
        hostMessage?: Shape;
        path: BaseRoutePath;
    }
    Index

    Properties

    clientMessage? connectProtocol? hostMessage? path

    Properties

    clientMessage?: Shape

    Allowed messages from the WebSocket client.

    connectProtocol?: WebSocketConnectProtocolRequirement

    Allowed connection protocols for this WebSocket. Each protocol the client sends is matched against the requirement; the client must supply at least one matching protocol when the requirement is set.

    Modeled the same way as searchParams:

    • A Shape (runtime type usually a string or string union): each supplied protocol must satisfy the shape.
    • A RegExp: each supplied protocol must match the regex.
    • A ReadonlyArray<Shape | RegExp>: each supplied protocol must satisfy at least one entry. Order is not significant. The array is treated as a list of alternatives.
    hostMessage?: Shape

    Allowed messages from the WebSocket host.

    path: BaseRoutePath

    Settings

    Member Visibility

    On This Page

    Properties