@types/fetch-mock

call signature

(input?: string | Request, init?: RequestInit): Promise<Response>;

• Also callable as fetch(). Use typeof fetch in your code to define a field that accepts both fetch() and a fetch-mock sandbox.

property config

config: {
    /**
     * Convert objects into JSON before delivering as stub responses.
     * Can be useful to set to false globally if e.g. dealing with a
     * lot of array buffers. If true, will also add
     * content-type: application/json header.
     * @default true
     */
    sendAsJson?: boolean | undefined;

    /**
     * Automatically sets a content-length header on each response.
     * @default true
     */
    includeContentLength?: boolean | undefined;

    /**
     * - true: Unhandled calls fall through to the network
     * - false: Unhandled calls throw an error
     * - 'always': All calls fall through to the network, effectively
     * disabling fetch-mock.
     * @default false
     */
    fallbackToNetwork?: boolean | 'always' | undefined;

    /**
     * Determines behaviour if a new route has the same name (or
     * inferred name) as an existing one
     * - undefined: An error will be throw when routes clash
     * - true: Overwrites the existing route
     * - false: Appends the new route to the list of routes
     * @default undefined
     */
    overwriteRoutes?: boolean | undefined;

    /**
     * Print a warning if any call is caught by a fallback handler (set
     * using the fallbackToNetwork option or catch())
     * @default true
     */
    warnOnFallback?: boolean | undefined;

    /**
     * Reference to the Promise constructor of a custom Promise
     * implementation.
     */
    Promise?: new (
        executor: (
            resolve: (value: Response | PromiseLike<Response>) => void,
            reject: (reason?: any) => void
        ) => void
    ) => Promise<Response> | undefined | undefined;

    /**
     * Reference to a custom fetch implementation.
     */
    fetch?:
        | ((input?: string | Request, init?: RequestInit) => Promise<Response>)
        | undefined;

    /**
     * Reference to the Headers constructor of a custom fetch
     * implementation.
     */
    Headers?: (new () => Headers | undefined) | undefined;

    /**
     * Reference to the Request constructor of a custom fetch
     * implementation.
     */
    Request?:
        | (new (input: string | Request, init?: RequestInit) =>
              | Request
              | undefined)
        | undefined;

    /**
     * Reference to the Response constructor of a custom fetch
     * implementation.
     */
    Response?: (new () => Response | undefined) | undefined;
};

property MATCHED

MATCHED: true;

property UNMATCHED

UNMATCHED: false;

method called

called: (filter?: InspectionFilter, options?: InspectionOptions) => boolean;

• Returns a Boolean indicating whether any calls to fetch matched the given filter.

  Parameter filter

  Allows filtering of calls to fetch based on various criteria

  Parameter options

  Either an object compatible with the mocking api or a string specifying a http method to filter by. This will be used to filter the list of calls further.

method calls

calls: (filter?: InspectionFilter, options?: InspectionOptions) => MockCall[];

• Returns an array of all calls to fetch matching the given filters. Each call is returned as a [url, options] array. If fetch was called using a Request instance, this will be available as a request property on this array.

  Parameter filter

  Allows filtering of calls to fetch based on various criteria

  Parameter options

  Either an object compatible with the mocking api or a string specifying a http method to filter by. This will be used to filter the list of calls further.

method catch

catch: (response?: MockResponse | MockResponseFunction) => this;

• Chainable method that defines how to respond to calls to fetch that don't match any of the defined mocks. It accepts the same types of response as a normal call to .mock(matcher, response). It can also take an arbitrary function to completely customise behaviour of unmatched calls. If .catch() is called without any parameters then every unmatched call will receive a 200 response.

  Parameter response

  Configures the http response returned by the mock

method delete

delete: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodDelete
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the DELETE method. Calls to .delete() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method deleteOnce

deleteOnce: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodDelete
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the DELETE method and limited to being called one time only. Calls to .deleteOnce() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method done

done: (filter?: InspectionFilter) => boolean;

• Returns a Boolean indicating whether fetch was called the expected number of times (or has been called at least once if repeat is undefined for the route).

  Parameter filter

  Rule for matching calls to fetch.

method flush

flush: (waitForBody?: boolean) => Promise<MockResponse[]>;

• Returns a promise that resolves once all fetches handled by fetch-mock have resolved.

  Parameter waitForBody

  Wait for all body parsing methods(res.json(), res.text(), etc.) to resolve too.

method get

get: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodGet
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the GET method. Calls to .get() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method getOnce

getOnce: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodGet
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the GET method and limited to being called one time only. Calls to .getOnce() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method head

head: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodHead
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the HEAD method. Calls to .head() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method headOnce

headOnce: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodHead
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the HEAD method and limited to being called one time only. Calls to .headOnce() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method lastCall

lastCall: (
    filter?: InspectionFilter,
    options?: InspectionOptions
) => MockCall | undefined;

• Returns the arguments for the last call to fetch matching the given filter.

  Parameter filter

  Allows filtering of calls to fetch based on various criteria

  Parameter options

  Either an object compatible with the mocking api or a string specifying a http method to filter by. This will be used to filter the list of calls further.

method lastOptions

lastOptions: (
    filter?: InspectionFilter,
    options?: InspectionOptions
) => MockOptions | undefined;

• Returns the options for the call to fetch matching the given filter. If fetch was last called using a Request instance, a set of options inferred from the Request will be returned.

  Parameter filter

  Allows filtering of calls to fetch based on various criteria

  Parameter options

  Either an object compatible with the mocking api or a string specifying a http method to filter by. This will be used to filter the list of calls further.

method lastUrl

lastUrl: (
    filter?: InspectionFilter,
    options?: InspectionOptions
) => string | undefined;

• Returns the url for the last call to fetch matching the given filter. If fetch was last called using a Request instance, the url will be extracted from this.

  Parameter filter

  Allows filtering of calls to fetch based on various criteria

  Parameter options

  Either an object compatible with the mocking api or a string specifying a http method to filter by. This will be used to filter the list of calls further.

method mock

mock: {
    (
        matcher: MockMatcher,
        response: MockResponse | MockResponseFunction,
        options?: MockOptions
    ): this;
    (options: MockOptions): this;
};

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Calls to .mock() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Calls to .mock() can be chained.

  Parameter options

  The route to mock

method once

once: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptions
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() limited to being called one time only. Calls to .once() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Optional additional properties defining the route to mock

method patch

patch: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodHead
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the PATCH method. Calls to .patch() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method patchOnce

patchOnce: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodHead
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the PATCH method and limited to being called one time only. Calls to .patchOnce() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method post

post: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodPost
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the POST method. Calls to .post() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method postOnce

postOnce: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodPost
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the POST method and limited to being called one time only. Calls to .postOnce() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method put

put: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodPut
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the PUT method. Calls to .put() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method putOnce

putOnce: (
    matcher: MockMatcher,
    response: MockResponse | MockResponseFunction,
    options?: MockOptionsMethodPut
) => this;

• Replaces fetch() with a stub which records its calls, grouped by route, and optionally returns a mocked Response object or passes the call through to fetch(). Shorthand for mock() restricted to the PUT method and limited to being called one time only. Calls to .putOnce() can be chained.

  Parameter matcher

  Condition for selecting which requests to mock

  Parameter response

  Configures the http response returned by the mock

  Parameter options

  Additional properties defining the route to mock

method reset

reset: () => this;

• Restores fetch() to its unstubbed state and clears all data recorded for its calls. reset() is an alias for restore().

method resetBehavior

resetBehavior: () => this;

• Removes mocking behaviour without resetting call history.

method resetHistory

resetHistory: () => this;

• Clears all data recorded for fetch()’s calls. It will not restore fetch to its default implementation.

method restore

restore: () => this;

• Restores fetch() to its unstubbed state and clears all data recorded for its calls. reset() is an alias for restore().

method sandbox

sandbox: () => FetchMockSandbox;

• Returns a drop-in mock for fetch which can be passed to other mocking libraries. It implements the full fetch-mock api and maintains its own state independent of other instances, so tests can be run in parallel.

method spy

spy: (response?: MockResponse | MockResponseFunction) => this;

• Chainable method that records the call history of unmatched calls, but instead of responding with a stubbed response, the request is passed through to native fetch() and is allowed to communicate over the network. Similar to catch().

property 0

0: string;

property 1

1: RequestInit | undefined;

property identifier

identifier: string;

property isUnmatched

isUnmatched: boolean | undefined;

property request

request: Request | undefined;

property body

body?: string | {} | undefined;

• body to match

property functionMatcher

functionMatcher?: MockMatcherFunction | undefined;

• A function for arbitrary matching

property headers

headers?: { [key: string]: string | number } | undefined;

• key/value map of headers to match

property includeContentLength

includeContentLength?: boolean | undefined;

• Automatically sets a content-length header on each response. true

property matcher

matcher?: MockMatcher | undefined;

• as specified above

property method

method?: string | undefined;

• http method to match

property name

name?: string | undefined;

• A unique string naming the route. Used to subsequently retrieve references to the calls, grouped by name. matcher.toString()

  Note: If a non-unique name is provided no error will be thrown (because names are optional, auto-generated ones may legitimately clash)

property overwriteRoutes

overwriteRoutes?: boolean | undefined;

• This option allows for existing routes in a mock to be overwritten. It’s also possible to define multiple routes with ‘the same’ matcher. Default behaviour is to error

property params

params?: { [key: string]: string } | undefined;

• key/value map of express style path params to match

property query

query?: { [key: string]: string } | undefined;

• key/value map of query strings to match, in any order

property repeat

repeat?: number | undefined;

• integer, n, limiting the number of times the matcher can be used. If the route has already been called n times the route will be ignored and the call to fetch() will fall through to be handled by any other routes defined (which may eventually result in an error if nothing matches it).

property response

response?: MockResponse | MockResponseFunction | undefined;

• as specified above

property sendAsJson

sendAsJson?: boolean | undefined;

• Convert objects into JSON before delivering as stub responses. Can be useful to set to false globally if e.g. dealing with a lot of array buffers. If true, will also add content-type: application/json header. true

property method

method?: 'DELETE' | undefined;

property method

method?: 'GET' | undefined;

property method

method?: 'HEAD' | undefined;

property method

method?: 'POST' | undefined;

property method

method?: 'PUT' | undefined;

property body

body?: string | {} | undefined;

• Set the response body

property headers

headers?: { [key: string]: string } | undefined;

• Set the response headers.

property redirectUrl

redirectUrl?: string | undefined;

• The URL the response should be from (to imitate followed redirects - will set redirected: true on the response)

property status

status?: number | undefined;

• Set the response status 200

property throws

throws?: Error | undefined;

• If this property is present then a Promise rejected with the value of throws is returned