Interface Ffetch<RequestMixin, ResponseMixin>

the main function of the library

interface Ffetch<RequestMixin, ResponseMixin> {
    delete: (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ) => FfetchResult & ResponseMixin;
    extend: <
        const Addons extends FfetchAddon<any, any>[],
        Combined extends
            { request: object; response: object } = CombineAddons<Addons>,
    >(
        baseOptions: FfetchBaseOptions<Addons> & Combined["request"],
    ) => Ffetch<
        RequestMixin & Combined["request"],
        ResponseMixin & Combined["response"],
    >;
    get: (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ) => FfetchResult & ResponseMixin;
    head: (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ) => FfetchResult & ResponseMixin;
    options: (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ) => FfetchResult & ResponseMixin;
    patch: (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ) => FfetchResult & ResponseMixin;
    post: (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ) => FfetchResult & ResponseMixin;
    put: (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ) => FfetchResult & ResponseMixin;
    (
        url: string,
        params?: FfetchOptions & RequestMixin,
    ): FfetchResult & ResponseMixin;
}

Type Parameters

  • RequestMixin
  • ResponseMixin

Properties

delete extend get head options patch post put

Properties

delete

delete: (
    url: string,
    params?: FfetchOptions & RequestMixin,
) => FfetchResult & ResponseMixin

shorthand for making a DELETE request

extend

extend: <
    const Addons extends FfetchAddon<any, any>[],
    Combined extends
        { request: object; response: object } = CombineAddons<Addons>,
>(
    baseOptions: FfetchBaseOptions<Addons> & Combined["request"],
) => Ffetch<
    RequestMixin & Combined["request"],
    ResponseMixin & Combined["response"],
>

extend the base options with the given options

note: addons, middlewares and headers will be merged with the base options, the rest of the options will be overridden

get

get: (
    url: string,
    params?: FfetchOptions & RequestMixin,
) => FfetchResult & ResponseMixin

shorthand for making a GET request

head

head: (
    url: string,
    params?: FfetchOptions & RequestMixin,
) => FfetchResult & ResponseMixin

shorthand for making a HEAD request

options

options: (
    url: string,
    params?: FfetchOptions & RequestMixin,
) => FfetchResult & ResponseMixin

shorthand for making an OPTIONS request

patch

patch: (
    url: string,
    params?: FfetchOptions & RequestMixin,
) => FfetchResult & ResponseMixin

shorthand for making a PATCH request

post

post: (
    url: string,
    params?: FfetchOptions & RequestMixin,
) => FfetchResult & ResponseMixin

shorthand for making a POST request

put

put: (
    url: string,
    params?: FfetchOptions & RequestMixin,
) => FfetchResult & ResponseMixin

shorthand for making a PUT request

Settings

Member Visibility

On This Page

Properties