@aurelia/fetch-client/dist/types/http-client.d.ts

[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [![CircleCI](https://circleci.com/

import { HttpClientConfiguration } from './http-client-configuration';
import { IFetchInterceptor } from './interfaces';
/**
 * An interface to resolve what fetch function will be used for the http client
 * Default to the global fetch function via global `fetch` variable.
 */
export declare const IFetchFn: import("@aurelia/kernel").InterfaceSymbol<typeof fetch>;
export declare const IHttpClient: import("@aurelia/kernel").InterfaceSymbol<IHttpClient>;
export interface IHttpClient extends HttpClient {
}
/**
 * An HTTP client based on the Fetch API.
 */
export declare class HttpClient {
    /**
     * The current number of active requests.
     * Requests being processed by interceptors are considered active.
     */
    activeRequestCount: number;
    /**
     * Indicates whether or not the client is currently making one or more requests.
     */
    isRequesting: boolean;
    /**
     * Indicates whether or not the client has been configured.
     */
    isConfigured: boolean;
    /**
     * The base URL set by the config.
     */
    baseUrl: string;
    /**
     * The default request init to merge with values specified at request time.
     */
    defaults: RequestInit | null;
    /**
     * The interceptors to be run during requests.
     */
    get interceptors(): IFetchInterceptor[];
    /**
     * Configure this client with default settings to be used by all requests.
     *
     * @param config - A configuration object, or a function that takes a config
     * object and configures it.
     * @returns The chainable instance of this HttpClient.
     * @chainable
     */
    configure(config: RequestInit | ((config: HttpClientConfiguration) => HttpClientConfiguration | void) | HttpClientConfiguration): HttpClient;
    /**
     * Starts the process of fetching a resource. Default configuration parameters
     * will be applied to the Request. The constructed Request will be passed to
     * registered request interceptors before being sent. The Response will be passed
     * to registered Response interceptors before it is returned.
     *
     * See also https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
     *
     * @param input - The resource that you wish to fetch. Either a
     * Request object, or a string containing the URL of the resource.
     * @param init - An options object containing settings to be applied to
     * the Request.
     * @returns A Promise for the Response from the fetch request.
     */
    fetch(input: Request | string, init?: RequestInit): Promise<Response>;
    /**
     * Creates a new Request object using the current configuration of this http client
     */
    buildRequest(input: string | Request, init: RequestInit | undefined): Request;
    /**
     * Calls fetch as a GET request.
     *
     * @param input - The resource that you wish to fetch. Either a
     * Request object, or a string containing the URL of the resource.
     * @param init - An options object containing settings to be applied to
     * the Request.
     * @returns A Promise for the Response from the fetch request.
     */
    get(input: Request | string, init?: RequestInit): Promise<Response>;
    /**
     * Calls fetch with request method set to POST.
     *
     * @param input - The resource that you wish to fetch. Either a
     * Request object, or a string containing the URL of the resource.
     * @param body - The body of the request.
     * @param init - An options object containing settings to be applied to
     * the Request.
     * @returns A Promise for the Response from the fetch request.
     */
    post(input: Request | string, body?: BodyInit, init?: RequestInit): Promise<Response>;
    /**
     * Calls fetch with request method set to PUT.
     *
     * @param input - The resource that you wish to fetch. Either a
     * Request object, or a string containing the URL of the resource.
     * @param body - The body of the request.
     * @param init - An options object containing settings to be applied to
     * the Request.
     * @returns A Promise for the Response from the fetch request.
     */
    put(input: Request | string, body?: BodyInit, init?: RequestInit): Promise<Response>;
    /**
     * Calls fetch with request method set to PATCH.
     *
     * @param input - The resource that you wish to fetch. Either a
     * Request object, or a string containing the URL of the resource.
     * @param body - The body of the request.
     * @param init - An options object containing settings to be applied to
     * the Request.
     * @returns A Promise for the Response from the fetch request.
     */
    patch(input: Request | string, body?: BodyInit, init?: RequestInit): Promise<Response>;
    /**
     * Calls fetch with request method set to DELETE.
     *
     * @param input - The resource that you wish to fetch. Either a
     * Request object, or a string containing the URL of the resource.
     * @param body - The body of the request.
     * @param init - An options object containing settings to be applied to
     * the Request.
     * @returns A Promise for the Response from the fetch request.
     */
    delete(input: Request | string, body?: BodyInit, init?: RequestInit): Promise<Response>;
    /**
     * Dispose and cleanup used resources of this client.
     */
    dispose(): void;
    private processRequest;
    private processResponse;
}
/**
 * A lookup containing events used by HttpClient.
 */
export declare const HttpClientEvent: Readonly<{
    /**
     * Event to be triggered when a request is sent.
     */
    started: "aurelia-fetch-client-request-started";
    /**
     * Event to be triggered when a request is completed.
     */
    drained: "aurelia-fetch-client-requests-drained";
}>;
//# sourceMappingURL=http-client.d.ts.map