Class Client

ReadonlyclientIdentifier

ReadonlyRouteType

ws

• get ws(): WebSocket

  WebSocket connection.

  Returns WebSocket

  Throws

  an error if the client has not been connected yet with Client.connect

attachExternalClientSideRouteHandler

• attachExternalClientSideRouteHandler<TCallbackArgs extends unknown[], TResult>(
      options: {
          extractRequest: (...args: TCallbackArgs) => Request | Promise<Request>;
          handleResult: (
              response: undefined | ExternalRouteHandlerRouteResponse,
              ...args: TCallbackArgs,
          ) => undefined | TResult | Promise<undefined | TResult>;
      },
  ): (...args: TCallbackArgs) => Promise<undefined | TResult>
  Internal

  Allows an external handler to be injected into the route handling process for dealing with client-side request interception.

  Type Parameters

  • TCallbackArgs extends unknown[]
  • TResult

  Parameters

  • options: {
        extractRequest: (...args: TCallbackArgs) => Request | Promise<Request>;
        handleResult: (
            response: undefined | ExternalRouteHandlerRouteResponse,
            ...args: TCallbackArgs,
        ) => undefined | TResult | Promise<undefined | TResult>;
    }

    options for the external route handler

    • extractRequest: (...args: TCallbackArgs) => Request | Promise<Request>

      a function that extracts a request from the arguments passed to the external handler

    • handleResult: (
          response: undefined | ExternalRouteHandlerRouteResponse,
          ...args: TCallbackArgs,
      ) => undefined | TResult | Promise<undefined | TResult>

      a function that transforms the internal result to the external handlers expected result

  Returns (...args: TCallbackArgs) => Promise<undefined | TResult>

  a function that acts as a handler for the external route handler

connect

• connect(options: ConnectOptions): Promise<void>

  Used to connect the client to the WebSocket server. This will also identify the client on the server to enable concurrency for mocking. You need to call this method before you can register any route handlers.

  Parameters

  • options: ConnectOptions

    Options for the connection.

  Returns Promise<void>

disconnect

• disconnect(): void

  Disconnects the WebSocket connection. You need to run Client.connect again to reconnect.

  Returns void

  Remarks

  Route handlers and message handlers are not removed when the client disconnects.

off

• off<TMessageType extends MessageType>(
      messageType: TMessageType,
      handler: (message: ParsedMessageType<TMessageType>) => void | Promise<void>,
  ): void

  Unregisters a handler for a specific message type.

  Type Parameters

  • TMessageType extends MessageType

  Parameters

  • messageType: TMessageType

    The type of message to handle.

  • handler: (message: ParsedMessageType<TMessageType>) => void | Promise<void>

    The original handler function that was registered.

  Returns void

on

• on<TMessageType extends MessageType>(
      messageType: TMessageType,
      handler: (message: ParsedMessageType<TMessageType>) => void | Promise<void>,
  ): void

  Registers a handler for a specific message type.

  Type Parameters

  • TMessageType extends MessageType

  Parameters

  • messageType: TMessageType

    The type of message to handle.

  • handler: (message: ParsedMessageType<TMessageType>) => void | Promise<void>

    The handler function to call when a message of the specified type is received. The handler function receives the parsed message as an argument.

  Returns void

route

• route(
      url: UrlMatcher,
      handler: (route: Route) => RouteResponse | Promise<RouteResponse>,
      options?: RouteOptions,
  ): string

  Registers a route handler, when the client receives a request message.

  Parameters

  • url: UrlMatcher

    the URL pattern to match against the incoming request URL

  • handler: (route: Route) => RouteResponse | Promise<RouteResponse>

    the function to handle the request

  • options: RouteOptions = {}

    optional options for the route handler

  Returns string

  a route handler ID that can be used to unregister the handler later if required

unroute

• unroute(routeHandlerId: string): void

  Used to unregister a route handler.

  Parameters

  • routeHandlerId: string

    the route handler ID returned from Client.route

  Returns void

unrouteAll

• unrouteAll(): void

  Removes all route handlers

  Returns void

waitForRequest

• waitForRequest(
      urlMatcher: UrlMatcher,
      options?: WaitForRequestOptions,
  ): Promise<Request>

  Waits for a request to be made that matches the given URL matcher.

  Parameters

  • urlMatcher: UrlMatcher

    The URL matcher to match against.

  • options: WaitForRequestOptions = {}

    Options for the wait operation.

  Returns Promise<Request>

  Promise resolving to an instance of Request matching the original request dispatched by the server, rejects with an error if the request is not found within the specified timeout duration.