Interface MockDispatch<TData, TError>

MockInterceptor options.

interface MockDispatch<TData, TError> {
    body?: string | RegExp | ((body) => boolean);
    consumed: boolean;
    data: MockDispatchData<TData, TError>;
    headers?: Record<string, string | RegExp | ((body) => boolean)> | ((headers) => boolean);
    method?: string | RegExp | ((method) => boolean);
    path: string | RegExp | ((path) => boolean);
    persist: boolean;
    query?: Record<string, any>;
    times: null | number;
}

Type Parameters

  • TData extends object = object

  • TError extends Error = Error

Hierarchy (view full)

Properties

body? consumed data headers? method? path persist query? times

Properties

Optional body

body?: string | RegExp | ((body) => boolean)

Body to intercept on.

Type declaration

    • (body): boolean

    • Parameters

      • body: string

      Returns boolean

consumed

consumed: boolean

data

data: MockDispatchData<TData, TError>

Optional headers

headers?: Record<string, string | RegExp | ((body) => boolean)> | ((headers) => boolean)

Headers to intercept on.

Type declaration

    • (headers): boolean

    • Parameters

      • headers: Record<string, string>

      Returns boolean

Optional method

method?: string | RegExp | ((method) => boolean)

Method to intercept on. Defaults to GET.

Type declaration

    • (method): boolean

    • Parameters

      • method: string

      Returns boolean

path

path: string | RegExp | ((path) => boolean)

Path to intercept on.

Type declaration

    • (path): boolean

    • Parameters

      • path: string

      Returns boolean

persist

persist: boolean

Optional query

query?: Record<string, any>

Query params to intercept on

times

times: null | number

Settings

Member Visibility

Theme

On This Page