Class ZHttpServiceMock

Represents a mock http service that can be useful for demos, testing, and pre-api implementations.

Implements

IZHttpService

Index

Constructors

Methods

Constructors

constructor

new ZHttpServiceMock(): ZHttpServiceMock
Returns ZHttpServiceMock

Methods

request

request<TResult = any, TBody = any>(
req: IZHttpRequest<TBody>,
): Promise<IZHttpResult<TResult>>
Invokes the request given the allowed api implementations.
Type Parameters
- TResult = any
- TBody = any
Parameters
- req: IZHttpRequest<TBody>
  The request that has been made.
Returns Promise<IZHttpResult<TResult>>
A promise that resolves with the given result if the status code is less than 400. Any status code above 400 will result in a rejected promise.
Implementation of IZHttpService.request
- Defined in packages/webigail-http/src/service/http-service-mock.mts:54

set

set<TResult = any>(
    endpoint: string,
    verb: ZHttpMethod,
    invoke:
        | IZHttpResult<TResult>
        | (
            (
                req: IZHttpRequest,
            ) => IZHttpResult<TResult> | Promise<IZHttpResult<TResult>>
        ),
): void
Sets the result of a given endpoint.
Type Parameters
- TResult = any
Parameters
- endpoint: string
  The endpoint to set.
- verb: ZHttpMethod
  The endpoint verb to respond to.
- invoke:
      | IZHttpResult<TResult>
      | (
          (
              req: IZHttpRequest,
          ) => IZHttpResult<TResult> | Promise<IZHttpResult<TResult>>
      )
  The result method. If this is falsy, then the endpoint is removed.
Returns void
- Defined in packages/webigail-http/src/service/http-service-mock.mts:30