Type Alias WebSocketImplementationBase<ThisWebSocket, HostContext, ExtraParams>

Generic implementation envelope for a single WebSocket. Host and client (mock) reuse this by supplying their own ExtraParams.

Package

@rest-vir/api

type WebSocketImplementationBase<
    ThisWebSocket extends
        Readonly<WebSocketDefinition> = WebSocketDefinition,
    HostContext = unknown,
    ExtraParams = unknown,
> = {
    definition: ThisWebSocket;
    implementation: WebSocketListenerImplementationsBase<
        ThisWebSocket,
        HostContext,
        ExtraParams,
    >;
    isEndpoint: false;
    isWebSocket: true;
    path: ThisWebSocket["path"];
}

Type Parameters

ThisWebSocket extends Readonly<WebSocketDefinition> = WebSocketDefinition
HostContext = unknown
ExtraParams = unknown

Index

Properties

definition implementation isEndpoint isWebSocket path

Properties

definition

definition: ThisWebSocket

implementation

implementation: WebSocketListenerImplementationsBase<
    ThisWebSocket,
    HostContext,
    ExtraParams,
>

isEndpoint

isEndpoint: false

isWebSocket

isWebSocket: true

path

path: ThisWebSocket["path"]