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

    Type Alias SendAndWaitForReplyParams<Location, WebSocketToConnect>

    SendAndWaitForReplyParams: (
        WebSocketToConnect extends NoParam
            ? { message?: any }
            : GetWebSocketMessageTypeFromLocation<
                Exclude<WebSocketToConnect, NoParam>,
                Location,
            > extends undefined
                ? {
                    message?: GetWebSocketMessageTypeFromLocation<
                        Exclude<WebSocketToConnect, NoParam>,
                        Location,
                    >;
                }
                : {
                    message: GetWebSocketMessageTypeFromLocation<
                        Exclude<WebSocketToConnect, NoParam>,
                        Location,
                    >;
                }
    ) & {
        replyCheck?: (
            messageFromHost: WebSocketToConnect extends NoParam
                ? any
                : Exclude<WebSocketToConnect, NoParam>["MessageFromHostType"],
        ) => MaybePromise<boolean>;
        timeout?: Readonly<AnyDuration>;
    }

    Parameters for the sendAndWaitForReply method that gets attached to WebSockets.

    Type Parameters

    • Location extends WebSocketLocation
    • WebSocketToConnect extends
          | Readonly<
              SelectFrom<
                  WebSocketDefinition,
                  { MessageFromClientType: true; MessageFromHostType: true },
              >,
          >
          | NoParam = NoParam

    Type declaration

    • OptionalreplyCheck?: (
          messageFromHost: WebSocketToConnect extends NoParam
              ? any
              : Exclude<WebSocketToConnect, NoParam>["MessageFromHostType"],
      ) => MaybePromise<boolean>

      An optional function to check if the current reply is the one you were waiting for.

      If this is set, sendAndWaitForReply will wait until a reply is received that matches this condition. If this not set, the first reply is used.

    • Optionaltimeout?: Readonly<AnyDuration>

      The duration to wait for a reply message. If this duration is exceeded and a response still hasn't been received, an error is thrown.

      {seconds: 10}

    @rest-vir/define-service

    Settings

    Member Visibility