fetch-mock

fetch-mock

Version 12.3.0
Published 10 hours ago
123 kB
5 dependencies
MIT license

Install

npm i fetch-mock

yarn add fetch-mock

pnpm add fetch-mock

Overview

Mock http requests made using fetch

Variables

variable defaultFetchMockConfig

const defaultFetchMockConfig: FetchMockConfig;

variable fetchMock

const fetchMock: FetchMock;

Classes

class FetchMock

class FetchMock {}

constructor

constructor(config: FetchMockConfig, router?: Router);

property any

any: (
    this: FetchMock,
    response: RouteResponse,
    options?: UserRouteConfig | string
) => FetchMock;

property anyOnce

anyOnce: (
    this: FetchMock,
    response: RouteResponse,
    options?: UserRouteConfig | string
) => FetchMock;

property callHistory

callHistory: CallHistory;

property config

config: FetchMockConfig;

property delete

delete: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property deleteOnce

deleteOnce: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property get

get: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property getOnce

getOnce: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property head

head: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property headOnce

headOnce: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property once

once: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property patch

patch: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property patchOnce

patchOnce: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property post

post: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property postOnce

postOnce: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property put

put: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property putOnce

putOnce: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

property router

router: Router;

property sticky

sticky: {
    (this: FetchMock, matcher: UserRouteConfig): FetchMock;
    (
        this: FetchMock,
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: UserRouteConfig | string
    ): FetchMock;
};

method catch

catch: (response?: RouteResponse) => FetchMock;

method clearHistory

clearHistory: () => FetchMock;

method createInstance

createInstance: () => FetchMock;

method defineMatcher

defineMatcher: (matcher: MatcherDefinition) => void;

method fetchHandler

fetchHandler: (
    this: FetchMock,
    requestInput: string | URL | Request,
    requestInit?: RequestInit
) => Promise<Response>;

method hardReset

hardReset: (options?: HardResetOptions) => FetchMock;

method mockGlobal

mockGlobal: (this: FetchMock) => FetchMock;

method modifyRoute

modifyRoute: (routeName: string, options: ModifyRouteConfig) => this;

method removeRoute

removeRoute: (routeName: string) => FetchMock;

method removeRoutes

removeRoutes: (options?: RemoveRouteOptions) => FetchMock;

method route

route: {
    (matcher: UserRouteConfig): FetchMock;
    (
        matcher: RouteMatcher,
        response: RouteResponse,
        options?: string | UserRouteConfig
    ): FetchMock;
};

method spy

spy: (
    this: FetchMock,
    matcher?: RouteMatcher | UserRouteConfig,
    name?: RouteName
) => FetchMock;

method spyGlobal

spyGlobal: (this: FetchMock) => FetchMock;

method unmockGlobal

unmockGlobal: (this: FetchMock) => FetchMock;

Type Aliases

type CallHistoryFilter

type CallHistoryFilter = RouteName | Matched | Unmatched | boolean | RouteMatcher;

type CallLog

type CallLog = {
    args: unknown[];
    url: string;
    options: NormalizedRequestOptions;
    request?: Request;
    signal?: AbortSignal;
    route?: Route;
    response?: Response;
    expressParams?: {
        [x: string]: string;
    };
    queryParams?: URLSearchParams;
    pendingPromises: Promise<unknown>[];
};

type FetchMockConfig

type FetchMockConfig = FetchMockGlobalConfig & FetchImplementations;

type MatcherDefinition

type MatcherDefinition = {
    name: string;
    matcher: MatcherGenerator;
    usesBody?: boolean;
};

type ModifyRouteConfig

type ModifyRouteConfig = Omit<Nullable<UserRouteSpecificConfig>, 'name' | 'sticky'>;

type RemoveRouteOptions

type RemoveRouteOptions = {
    includeSticky?: boolean;
    includeFallback?: boolean;
    names?: string[];
};

type RouteMatcher

type RouteMatcher = RouteMatcherUrl | RouteMatcherFunction;

type RouteName

type RouteName = string;

type RouteResponse

type RouteResponse =
    | RouteResponseData
    | RouteResponsePromise
    | RouteResponseFunction;

type UserRouteConfig

type UserRouteConfig = UserRouteSpecificConfig & FetchMockGlobalConfig;

Package Files (6)

Dependencies (5)

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/fetch-mock.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/fetch-mock)

HTML

<a href="https://www.jsdocs.io/package/fetch-mock"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated just now.
Package analyzed in 3821 ms.
Missing or incorrect documentation? Open an issue for this package.

fetch-mock

Install

Overview

Index

Variables

Classes

Type Aliases

Variables

variable defaultFetchMockConfig

variable fetchMock

Classes

class FetchMock

constructor

property any

property anyOnce

property callHistory

property config

property delete

property deleteOnce

property get

property getOnce

property head

property headOnce

property once

property patch

property patchOnce

property post

property postOnce

property put

property putOnce

property router

property sticky

method catch

method clearHistory

method createInstance

method defineMatcher

method fetchHandler

method hardReset

method mockGlobal

method modifyRoute

method removeRoute

method removeRoutes

method route

method spy

method spyGlobal

method unmockGlobal

Type Aliases

type CallHistoryFilter

type CallLog

type FetchMockConfig

type MatcherDefinition

type ModifyRouteConfig

type RemoveRouteOptions

type RouteMatcher

type RouteName

type RouteResponse

type UserRouteConfig

Package Files (6)

Dependencies (5)

Dev Dependencies (0)

Peer Dependencies (0)

Badge