hapic/dist/request/type.d.ts

A http api client based on axios.

import type { ProxyOptions } from '../fetch';
import type { ResponseType } from '../constants';
import type { ResponseTransformer } from '../response';
export type RequestInit = globalThis.RequestInit;
export type RequestInfo = globalThis.RequestInfo;
export type RequestTransformer = (data: any, headers: Headers) => any;
export type RequestBaseOptions<R extends `${ResponseType}` = `${ResponseType.JSON}`> = Omit<RequestInit, 'body'> & {
    /**
     * The base URL for the HTTP endpoints.
     */
    baseURL?: string;
    /**
     * The request body.
     */
    body?: RequestInit['body'] | Record<string, any>;
    /**
     * The desired response type.
     *
     * default: CONTENT_TYPE header
     */
    responseType?: R;
    /**
     * A function or array of functions to transform the response data.
     */
    responseTransform?: ResponseTransformer | ResponseTransformer[];
    /**
     * Query string parameters for the request.
     */
    params?: Record<string, any>;
    /**
     * Activate or deactivate the use of proxies or enter customized options.
     * By default, https_proxy, http_proxy, HTTPS_PROXY, and HTTP_PROXY environment variables will be checked and used.
     *
     * default: true (disable with false)
     */
    proxy?: ProxyOptions | boolean;
    /**
     * Query string parameters for the request.
     */
    query?: Record<string, any>;
    /**
     * A function or array of functions to transform the request data.
     */
    transform?: RequestTransformer | RequestTransformer[];
    /**
     * Proxy agent configuration (Node.js only).
     */
    agent?: ((url: URL) => any) | any;
};
export type RequestOptions<R extends `${ResponseType}` = `${ResponseType}`> = RequestBaseOptions<R> & {
    url: string;
};