123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254 |
- // TypeScript Version: 3.0
- export type AxiosRequestHeaders = Record<string, string | number | boolean>;
- export type AxiosResponseHeaders = Record<string, string> & {
- "set-cookie"?: string[]
- };
- export interface AxiosRequestTransformer {
- (data: any, headers?: AxiosRequestHeaders): any;
- }
- export interface AxiosResponseTransformer {
- (data: any, headers?: AxiosResponseHeaders): any;
- }
- export interface AxiosAdapter {
- (config: AxiosRequestConfig): AxiosPromise;
- }
- export interface AxiosBasicCredentials {
- username: string;
- password: string;
- }
- export interface AxiosProxyConfig {
- host: string;
- port: number;
- auth?: {
- username: string;
- password: string;
- };
- protocol?: string;
- }
- export type Method =
- | 'get' | 'GET'
- | 'delete' | 'DELETE'
- | 'head' | 'HEAD'
- | 'options' | 'OPTIONS'
- | 'post' | 'POST'
- | 'put' | 'PUT'
- | 'patch' | 'PATCH'
- | 'purge' | 'PURGE'
- | 'link' | 'LINK'
- | 'unlink' | 'UNLINK';
- export type ResponseType =
- | 'arraybuffer'
- | 'blob'
- | 'document'
- | 'json'
- | 'text'
- | 'stream';
- export type responseEncoding =
- | 'ascii' | 'ASCII'
- | 'ansi' | 'ANSI'
- | 'binary' | 'BINARY'
- | 'base64' | 'BASE64'
- | 'base64url' | 'BASE64URL'
- | 'hex' | 'HEX'
- | 'latin1' | 'LATIN1'
- | 'ucs-2' | 'UCS-2'
- | 'ucs2' | 'UCS2'
- | 'utf-8' | 'UTF-8'
- | 'utf8' | 'UTF8'
- | 'utf16le' | 'UTF16LE';
- export interface TransitionalOptions {
- silentJSONParsing?: boolean;
- forcedJSONParsing?: boolean;
- clarifyTimeoutError?: boolean;
- }
- export interface AxiosRequestConfig<D = any> {
- url?: string;
- method?: Method | string;
- baseURL?: string;
- transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
- transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
- headers?: AxiosRequestHeaders;
- params?: any;
- paramsSerializer?: (params: any) => string;
- data?: D;
- timeout?: number;
- timeoutErrorMessage?: string;
- withCredentials?: boolean;
- adapter?: AxiosAdapter;
- auth?: AxiosBasicCredentials;
- responseType?: ResponseType;
- responseEncoding?: responseEncoding | string;
- xsrfCookieName?: string;
- xsrfHeaderName?: string;
- onUploadProgress?: (progressEvent: any) => void;
- onDownloadProgress?: (progressEvent: any) => void;
- maxContentLength?: number;
- validateStatus?: ((status: number) => boolean) | null;
- maxBodyLength?: number;
- maxRedirects?: number;
- beforeRedirect?: (options: Record<string, any>, responseDetails: {headers: Record<string, string>}) => void;
- socketPath?: string | null;
- httpAgent?: any;
- httpsAgent?: any;
- proxy?: AxiosProxyConfig | false;
- cancelToken?: CancelToken;
- decompress?: boolean;
- transitional?: TransitionalOptions;
- signal?: AbortSignal;
- insecureHTTPParser?: boolean;
- env?: {
- FormData?: new (...args: any[]) => object;
- };
- }
- export interface HeadersDefaults {
- common: AxiosRequestHeaders;
- delete: AxiosRequestHeaders;
- get: AxiosRequestHeaders;
- head: AxiosRequestHeaders;
- post: AxiosRequestHeaders;
- put: AxiosRequestHeaders;
- patch: AxiosRequestHeaders;
- options?: AxiosRequestHeaders;
- purge?: AxiosRequestHeaders;
- link?: AxiosRequestHeaders;
- unlink?: AxiosRequestHeaders;
- }
- export interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
- headers: HeadersDefaults;
- }
- export interface AxiosResponse<T = any, D = any> {
- data: T;
- status: number;
- statusText: string;
- headers: AxiosResponseHeaders;
- config: AxiosRequestConfig<D>;
- request?: any;
- }
- export class AxiosError<T = unknown, D = any> extends Error {
- constructor(
- message?: string,
- code?: string,
- config?: AxiosRequestConfig<D>,
- request?: any,
- response?: AxiosResponse<T, D>
- );
- config: AxiosRequestConfig<D>;
- code?: string;
- request?: any;
- response?: AxiosResponse<T, D>;
- isAxiosError: boolean;
- status?: string;
- toJSON: () => object;
- static readonly ERR_FR_TOO_MANY_REDIRECTS = "ERR_FR_TOO_MANY_REDIRECTS";
- static readonly ERR_BAD_OPTION_VALUE = "ERR_BAD_OPTION_VALUE";
- static readonly ERR_BAD_OPTION = "ERR_BAD_OPTION";
- static readonly ERR_NETWORK = "ERR_NETWORK";
- static readonly ERR_DEPRECATED = "ERR_DEPRECATED";
- static readonly ERR_BAD_RESPONSE = "ERR_BAD_RESPONSE";
- static readonly ERR_BAD_REQUEST = "ERR_BAD_REQUEST";
- static readonly ERR_CANCELED = "ERR_CANCELED";
- static readonly ECONNABORTED = "ECONNABORTED";
- static readonly ETIMEDOUT = "ETIMEDOUT";
- }
- export class CanceledError<T> extends AxiosError<T> {
- }
- export interface AxiosPromise<T = any> extends Promise<AxiosResponse<T>> {
- }
- export interface CancelStatic {
- new (message?: string): Cancel;
- }
- export interface Cancel {
- message: string | undefined;
- }
- export interface Canceler {
- (message?: string): void;
- }
- export interface CancelTokenStatic {
- new (executor: (cancel: Canceler) => void): CancelToken;
- source(): CancelTokenSource;
- }
- export interface CancelToken {
- promise: Promise<Cancel>;
- reason?: Cancel;
- throwIfRequested(): void;
- }
- export interface CancelTokenSource {
- token: CancelToken;
- cancel: Canceler;
- }
- export interface AxiosInterceptorOptions {
- synchronous?: boolean;
- runWhen?: (config: AxiosRequestConfig) => boolean;
- }
- export interface AxiosInterceptorManager<V> {
- use<T = V>(onFulfilled?: (value: V) => T | Promise<T>, onRejected?: (error: any) => any, options?: AxiosInterceptorOptions): number;
- eject(id: number): void;
- }
- export class Axios {
- constructor(config?: AxiosRequestConfig);
- defaults: AxiosDefaults;
- interceptors: {
- request: AxiosInterceptorManager<AxiosRequestConfig>;
- response: AxiosInterceptorManager<AxiosResponse>;
- };
- getUri(config?: AxiosRequestConfig): string;
- request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>;
- get<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
- delete<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
- head<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
- options<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
- post<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
- put<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
- patch<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
- postForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
- putForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
- patchForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
- }
- export interface AxiosInstance extends Axios {
- (config: AxiosRequestConfig): AxiosPromise;
- (url: string, config?: AxiosRequestConfig): AxiosPromise;
- }
- export interface AxiosStatic extends AxiosInstance {
- create(config?: AxiosRequestConfig): AxiosInstance;
- Cancel: CancelStatic;
- CancelToken: CancelTokenStatic;
- Axios: typeof Axios;
- readonly VERSION: string;
- isCancel(value: any): boolean;
- all<T>(values: Array<T | Promise<T>>): Promise<T[]>;
- spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;
- isAxiosError(payload: any): payload is AxiosError;
- }
- declare const axios: AxiosStatic;
- export default axios;
|