declarations/fetch-mock/fetch-mock.d.ts

[](https://www.npmjs.com/package/declarations)

// Type definitions for fetch-mock 5.0.0
// Project: https://github.com/wheresrhys/fetch-mock
// Definitions by: Alexey Svetliakov <https://github.com/asvetliakov>, Tamir Duberstein <https://github.com/tamird>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference path="../whatwg-fetch/whatwg-fetch.d.ts" />

declare module "fetch-mock" {
    type MockRequest = Request | RequestInit;

    /**
     * Mock matcher function
     * @param url
     * @param opts
     */
    type MockMatcherFunction = (url: string, opts: MockRequest) => boolean
    /**
     * Mock matcher. Can be one of following:
     * string: Either
         * an exact url to match e.g. 'http://www.site.com/page.html'
         * if the string begins with a `^`, the string following the `^` must
           begin the url e.g. '^http://www.site.com' would match
           'http://www.site.com' or 'http://www.site.com/page.html'
         * '*' to match any url
     * RegExp: A regular expression to test the url against
     * Function(url, opts): A function (returning a Boolean) that is passed the
       url and opts fetch() is called with (or, if fetch() was called with one,
       the Request instance)
     */
    type MockMatcher = string | RegExp | MockMatcherFunction;

    /**
     * Mock response object
     */
    interface MockResponseObject {
        /**
         * Set the response body
         */
        body?: string | {};
        /**
         * Set the response status
         * @default 200
         */
        status?: number;
        /**
         * Set the response headers.
         */
        headers?: { [key: string]: string };
        /**
         * If this property is present then a Promise rejected with the value
           of throws is returned
         */
        throws?: boolean;
        /**
         * This property determines whether or not the request body should be
           JSON.stringified before being sent
         * @default true
         */
        sendAsJson?: boolean;
    }
    /**
     * Response: A Response instance - will be used unaltered
     * number: Creates a response with this status
     * string: Creates a 200 response with the string as the response body
     * object: As long as the object is not a MockResponseObject it is
       converted into a json string and returned as the body of a 200 response
     * If MockResponseObject was given then it's used to configure response
     * Function(url, opts): A function that is passed the url and opts fetch()
       is called with and that returns any of the responses listed above
     */
    type MockResponse = Response | Promise<Response>
                        | number | Promise<number>
                        | string | Promise<string>
                        | Object | Promise<Object>
                        | MockResponseObject | Promise<MockResponseObject>;
    /**
     * Mock response function
     * @param url
     * @param opts
     */
    type MockResponseFunction = (url: string, opts: MockRequest) => MockResponse;

    /**
     * Mock options object
     */
    interface MockOptions {
        /**
         * A unique string naming the route. Used to subsequently retrieve
           references to the calls, grouped by name.
         * @default 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)
         */
        name?: string;
        /**
         * http method to match
         */
        method?: string;
        /**
         * as specified above
         */
        matcher?: MockMatcher;
        /**
         * as specified above
         */
        response?: MockResponse | MockResponseFunction;
    }

    type MockCall = [string, MockRequest];

    interface MatchedRoutes {
        matched: Array<MockCall>;
        unmatched: Array<MockCall>;
    }

    interface MockOptionsMethodGet extends MockOptions {
      method: 'GET'
    }

    interface MockOptionsMethodPost extends MockOptions {
      method: 'POST'
    }

    interface MockOptionsMethodPut extends MockOptions {
      method: 'PUT'
    }

    interface MockOptionsMethodDelete extends MockOptions {
      method: 'DELETE'
    }

    interface MockOptionsMethodHead extends MockOptions {
      method: 'HEAD'
    }

    interface FetchMockStatic {
        /**
         * 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.
         * @param matcher Condition for selecting which requests to mock
         * @param response Configures the http response returned by the mock
         */
        mock(matcher: MockMatcher, response: MockResponse | MockResponseFunction): 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.
         * @param matcher Condition for selecting which requests to mock
         * @param response Configures the http response returned by the mock
         * @param options Additional properties defining the route to mock
         */
        mock(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(). Calls to .mock() can be chained.
         * @param options The route to mock
         */
        mock(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() restricted to the GET
           method. Calls to .mock() can be chained.
         * @param matcher Condition for selecting which requests to mock
         * @param response Configures the http response returned by the mock
         * @param [options] Additional properties defining the route to mock
         */
        get(matcher: MockMatcher, reponse: 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 POST
           method. Calls to .mock() can be chained.
         * @param matcher Condition for selecting which requests to mock
         * @param response Configures the http response returned by the mock
         * @param [options] Additional properties defining the route to mock
         */
        post(matcher: MockMatcher, reponse: 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 PUT
           method. Calls to .mock() can be chained.
         * @param matcher Condition for selecting which requests to mock
         * @param response Configures the http response returned by the mock
         * @param [options] Additional properties defining the route to mock
         */
        put(matcher: MockMatcher, reponse: 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
           DELETE method. Calls to .mock() can be chained.
         * @param matcher Condition for selecting which requests to mock
         * @param response Configures the http response returned by the mock
         * @param [options] Additional properties defining the route to mock
         */
        delete(matcher: MockMatcher, reponse: 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 HEAD
           method. Calls to .mock() can be chained.
         * @param matcher Condition for selecting which requests to mock
         * @param response Configures the http response returned by the mock
         * @param [options] Additional properties defining the route to mock
         */
        head(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodHead): this;
        /**
         * Chainable method that restores fetch() to its unstubbed state and
           clears all data recorded for its calls.
         */
        restore(): this;
        /**
         * Chainable method that clears all data recorded for fetch()'s calls
         */
        reset(): this;
        /**
         * Returns all calls to fetch, grouped by whether fetch-mock matched
           them or not.
         */
        calls(): MatchedRoutes;
        /**
         * Returns all calls to fetch matching matcherName.
         */
        calls(matcherName?: string): Array<MockCall>;
        /**
         * Returns a Boolean indicating whether fetch was called and a route
           was matched.
         */
        called(): boolean;
        /**
         * Returns a Boolean indicating whether fetch was called and a route
           named matcherName was matched.
         */
        called(matcherName?: string): boolean;
        /**
         * Returns the arguments for the last matched call to fetch
         */
        lastCall(): MockCall;
        /**
         * Returns the arguments for the last call to fetch matching
           matcherName
         */
        lastCall(matcherName?: string): MockCall;
        /**
         * Returns the url for the last matched call to fetch
         */
        lastUrl(): string;
        /**
         * Returns the url for the last call to fetch matching matcherName
         */
        lastUrl(matcherName?: string): string;
        /**
         * Returns the options for the last matched call to fetch
         */
        lastOptions(): MockRequest;
        /**
         * Returns the options for the last call to fetch matching matcherName
         */
        lastOptions(matcherName?: string): MockRequest;
        /**
         * Set some global config options, which include
             * sendAsJson [default `true`] - by default fetchMock will
               convert objects to JSON before sending. This is overrideable
               for each call but for some scenarios, e.g. when dealing with a
               lot of array buffers, it can be useful to default to `false`
         */
        configure(opts: Object): void;
    }

    var fetchMock: FetchMockStatic;
    export = fetchMock;
}