rest-vir - v1.0.0
    Preparing search index...

    Type Alias ConnectWebSocketParams<WebSocketToConnect, AllowWebSocketMock, WebSocketClass>

    ConnectWebSocketParams: {
        listeners?: ConnectWebSocketListeners<
            WebSocketToConnect,
            WebSocketClass,
        >;
    } & (
        IsNever<PathParams<WebSocketToConnect["path"]>> extends true
            ? { pathParams?: undefined }
            : PathParams<WebSocketToConnect["path"]> extends string
                ? {
                    pathParams: Readonly<
                        Record<PathParams<WebSocketToConnect["path"]>, string>,
                    >;
                }
                : { pathParams?: undefined }
    ) & (
        AllowWebSocketMock extends true
            ? Pick<
                GenericConnectWebSocketParams<WebSocketClass>,
                "webSocketConstructor",
            >
            : unknown
    ) & (
        WebSocketToConnect["protocolsShape"] extends undefined
            ? { protocols?: string[] }
            : { protocols: WebSocketToConnect["ProtocolsType"] }
    ) & (
        WebSocketToConnect["searchParamsShape"] extends undefined
            ? { searchParams?: never }
            : { searchParams: WebSocketToConnect["SearchParamsType"] }
    )

    Params for connectWebSocket.

    Type Parameters

    • WebSocketToConnect extends Readonly<
          SelectFrom<
              WebSocketDefinition,
              {
                  MessageFromClientType: true;
                  MessageFromHostType: true;
                  path: true;
                  protocolsShape: true;
                  ProtocolsType: true;
                  searchParamsShape: true;
                  SearchParamsType: true;
              },
          >,
      >
    • AllowWebSocketMock extends boolean = true
    • WebSocketClass extends CommonWebSocket = CommonWebSocket

    Type declaration

    @rest-vir/define-service

    Settings

    Member Visibility