rest-vir - v2.2.0
    Preparing search index...

    Function createMockEndpointFetch

    • Creates a mock fetch function that returns a mock Response object that matches the expectations of the given endpoint. For more generic fetch mocking, see createMockFetch.

      Type Parameters

      • const Endpoint extends EndpointDefinition
      • const Method extends "GET" | "PUT" | "POST" | "DELETE" | "PATCH" | "TRACE"
      • const Status extends
            | 100
            | 101
            | 102
            | 103
            | 200
            | 201
            | 202
            | 203
            | 204
            | 205
            | 206
            | 207
            | 208
            | 226
            | 300
            | 301
            | 302
            | 303
            | 304
            | 305
            | 306
            | 307
            | 308
            | 400
            | 401
            | 402
            | 403
            | 404
            | 405
            | 406
            | 407
            | 408
            | 409
            | 410
            | 411
            | 412
            | 413
            | 414
            | 415
            | 416
            | 417
            | 418
            | 421
            | 422
            | 423
            | 424
            | 425
            | 426
            | 428
            | 429
            | 431
            | 451
            | 500
            | 501
            | 502
            | 503
            | 504
            | 505
            | 506
            | 507
            | 508
            | 510
            | 511

      Parameters

      Returns {
          (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
          (input: string | URL | Request, init?: RequestInit): Promise<Response>;
      }

        • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
        • Parameters

          • input: URL | RequestInfo
          • Optionalinit: RequestInit

          Returns Promise<Response>

        • (input: string | URL | Request, init?: RequestInit): Promise<Response>
        • Parameters

          • input: string | URL | Request
          • Optionalinit: RequestInit

          Returns Promise<Response>

      import {createMockEndpointFetch, fetchEndpoint} from '@rest-vir/api';

      fetchEndpoint(myService.endpoints['/my-path'], {
      fetch: createMockEndpointFetch(myService.endpoints['/my-path'], {
      body: 'some body',
      // there are other properties that can be mocked as well, see the types for more details
      }),
      });