123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559 |
- // TypeScript Version: 4.7
- export type AxiosHeaderValue = AxiosHeaders | string | string[] | number | boolean | null;
- interface RawAxiosHeaders {
- [key: string]: AxiosHeaderValue;
- }
- type MethodsHeaders = Partial<{
- [Key in Method as Lowercase<Key>]: AxiosHeaders;
- } & {common: AxiosHeaders}>;
- type AxiosHeaderMatcher = string | RegExp | ((this: AxiosHeaders, value: string, name: string) => boolean);
- type AxiosHeaderParser = (this: AxiosHeaders, value: AxiosHeaderValue, header: string) => any;
- export class AxiosHeaders {
- constructor(
- headers?: RawAxiosHeaders | AxiosHeaders | string
- );
- [key: string]: any;
- set(headerName?: string, value?: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
- set(headers?: RawAxiosHeaders | AxiosHeaders | string, rewrite?: boolean): AxiosHeaders;
- get(headerName: string, parser: RegExp): RegExpExecArray | null;
- get(headerName: string, matcher?: true | AxiosHeaderParser): AxiosHeaderValue;
- has(header: string, matcher?: AxiosHeaderMatcher): boolean;
- delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean;
- clear(matcher?: AxiosHeaderMatcher): boolean;
- normalize(format: boolean): AxiosHeaders;
- concat(...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>): AxiosHeaders;
- toJSON(asStrings?: boolean): RawAxiosHeaders;
- static from(thing?: AxiosHeaders | RawAxiosHeaders | string): AxiosHeaders;
- static accessor(header: string | string[]): AxiosHeaders;
- static concat(...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>): AxiosHeaders;
- setContentType(value: ContentType, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
- getContentType(parser?: RegExp): RegExpExecArray | null;
- getContentType(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
- hasContentType(matcher?: AxiosHeaderMatcher): boolean;
- setContentLength(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
- getContentLength(parser?: RegExp): RegExpExecArray | null;
- getContentLength(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
- hasContentLength(matcher?: AxiosHeaderMatcher): boolean;
- setAccept(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
- getAccept(parser?: RegExp): RegExpExecArray | null;
- getAccept(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
- hasAccept(matcher?: AxiosHeaderMatcher): boolean;
- setUserAgent(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
- getUserAgent(parser?: RegExp): RegExpExecArray | null;
- getUserAgent(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
- hasUserAgent(matcher?: AxiosHeaderMatcher): boolean;
- setContentEncoding(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
- getContentEncoding(parser?: RegExp): RegExpExecArray | null;
- getContentEncoding(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
- hasContentEncoding(matcher?: AxiosHeaderMatcher): boolean;
- setAuthorization(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
- getAuthorization(parser?: RegExp): RegExpExecArray | null;
- getAuthorization(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
- hasAuthorization(matcher?: AxiosHeaderMatcher): boolean;
- [Symbol.iterator](): IterableIterator<[string, AxiosHeaderValue]>;
- }
- type CommonRequestHeadersList = 'Accept' | 'Content-Length' | 'User-Agent' | 'Content-Encoding' | 'Authorization';
- type ContentType = AxiosHeaderValue | 'text/html' | 'text/plain' | 'multipart/form-data' | 'application/json' | 'application/x-www-form-urlencoded' | 'application/octet-stream';
- export type RawAxiosRequestHeaders = Partial<RawAxiosHeaders & {
- [Key in CommonRequestHeadersList]: AxiosHeaderValue;
- } & {
- 'Content-Type': ContentType
- }>;
- export type AxiosRequestHeaders = RawAxiosRequestHeaders & AxiosHeaders;
- type CommonResponseHeadersList = 'Server' | 'Content-Type' | 'Content-Length' | 'Cache-Control'| 'Content-Encoding';
- type RawCommonResponseHeaders = {
- [Key in CommonResponseHeadersList]: AxiosHeaderValue;
- } & {
- "set-cookie": string[];
- };
- export type RawAxiosResponseHeaders = Partial<RawAxiosHeaders & RawCommonResponseHeaders>;
- export type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;
- export interface AxiosRequestTransformer {
- (this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
- }
- export interface AxiosResponseTransformer {
- (this: InternalAxiosRequestConfig, data: any, headers: AxiosResponseHeaders, status?: number): any;
- }
- export interface AxiosAdapter {
- (config: InternalAxiosRequestConfig): AxiosPromise;
- }
- export interface AxiosBasicCredentials {
- username: string;
- password: string;
- }
- export interface AxiosProxyConfig {
- host: string;
- port: number;
- auth?: AxiosBasicCredentials;
- protocol?: string;
- }
- export enum HttpStatusCode {
- Continue = 100,
- SwitchingProtocols = 101,
- Processing = 102,
- EarlyHints = 103,
- Ok = 200,
- Created = 201,
- Accepted = 202,
- NonAuthoritativeInformation = 203,
- NoContent = 204,
- ResetContent = 205,
- PartialContent = 206,
- MultiStatus = 207,
- AlreadyReported = 208,
- ImUsed = 226,
- MultipleChoices = 300,
- MovedPermanently = 301,
- Found = 302,
- SeeOther = 303,
- NotModified = 304,
- UseProxy = 305,
- Unused = 306,
- TemporaryRedirect = 307,
- PermanentRedirect = 308,
- BadRequest = 400,
- Unauthorized = 401,
- PaymentRequired = 402,
- Forbidden = 403,
- NotFound = 404,
- MethodNotAllowed = 405,
- NotAcceptable = 406,
- ProxyAuthenticationRequired = 407,
- RequestTimeout = 408,
- Conflict = 409,
- Gone = 410,
- LengthRequired = 411,
- PreconditionFailed = 412,
- PayloadTooLarge = 413,
- UriTooLong = 414,
- UnsupportedMediaType = 415,
- RangeNotSatisfiable = 416,
- ExpectationFailed = 417,
- ImATeapot = 418,
- MisdirectedRequest = 421,
- UnprocessableEntity = 422,
- Locked = 423,
- FailedDependency = 424,
- TooEarly = 425,
- UpgradeRequired = 426,
- PreconditionRequired = 428,
- TooManyRequests = 429,
- RequestHeaderFieldsTooLarge = 431,
- UnavailableForLegalReasons = 451,
- InternalServerError = 500,
- NotImplemented = 501,
- BadGateway = 502,
- ServiceUnavailable = 503,
- GatewayTimeout = 504,
- HttpVersionNotSupported = 505,
- VariantAlsoNegotiates = 506,
- InsufficientStorage = 507,
- LoopDetected = 508,
- NotExtended = 510,
- NetworkAuthenticationRequired = 511,
- }
- 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 GenericAbortSignal {
- readonly aborted: boolean;
- onabort?: ((...args: any) => any) | null;
- addEventListener?: (...args: any) => any;
- removeEventListener?: (...args: any) => any;
- }
- export interface FormDataVisitorHelpers {
- defaultVisitor: SerializerVisitor;
- convertValue: (value: any) => any;
- isVisitable: (value: any) => boolean;
- }
- export interface SerializerVisitor {
- (
- this: GenericFormData,
- value: any,
- key: string | number,
- path: null | Array<string | number>,
- helpers: FormDataVisitorHelpers
- ): boolean;
- }
- export interface SerializerOptions {
- visitor?: SerializerVisitor;
- dots?: boolean;
- metaTokens?: boolean;
- indexes?: boolean | null;
- }
- // tslint:disable-next-line
- export interface FormSerializerOptions extends SerializerOptions {
- }
- export interface ParamEncoder {
- (value: any, defaultEncoder: (value: any) => any): any;
- }
- export interface CustomParamsSerializer {
- (params: Record<string, any>, options?: ParamsSerializerOptions): string;
- }
- export interface ParamsSerializerOptions extends SerializerOptions {
- encode?: ParamEncoder;
- serialize?: CustomParamsSerializer;
- }
- type MaxUploadRate = number;
- type MaxDownloadRate = number;
- type BrowserProgressEvent = any;
- export interface AxiosProgressEvent {
- loaded: number;
- total?: number;
- progress?: number;
- bytes: number;
- rate?: number;
- estimated?: number;
- upload?: boolean;
- download?: boolean;
- event?: BrowserProgressEvent;
- }
- type Milliseconds = number;
- type AxiosAdapterName = 'xhr' | 'http' | string;
- type AxiosAdapterConfig = AxiosAdapter | AxiosAdapterName;
- export type AddressFamily = 4 | 6 | undefined;
- export interface LookupAddressEntry {
- address: string;
- family?: AddressFamily;
- }
- export type LookupAddress = string | LookupAddressEntry;
- export interface AxiosRequestConfig<D = any> {
- url?: string;
- method?: Method | string;
- baseURL?: string;
- transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
- transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
- headers?: (RawAxiosRequestHeaders & MethodsHeaders) | AxiosHeaders;
- params?: any;
- paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
- data?: D;
- timeout?: Milliseconds;
- timeoutErrorMessage?: string;
- withCredentials?: boolean;
- adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
- auth?: AxiosBasicCredentials;
- responseType?: ResponseType;
- responseEncoding?: responseEncoding | string;
- xsrfCookieName?: string;
- xsrfHeaderName?: string;
- onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
- onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
- maxContentLength?: number;
- validateStatus?: ((status: number) => boolean) | null;
- maxBodyLength?: number;
- maxRedirects?: number;
- maxRate?: number | [MaxUploadRate, MaxDownloadRate];
- beforeRedirect?: (options: Record<string, any>, responseDetails: {headers: Record<string, string>, statusCode: HttpStatusCode}) => void;
- socketPath?: string | null;
- transport?: any;
- httpAgent?: any;
- httpsAgent?: any;
- proxy?: AxiosProxyConfig | false;
- cancelToken?: CancelToken;
- decompress?: boolean;
- transitional?: TransitionalOptions;
- signal?: GenericAbortSignal;
- insecureHTTPParser?: boolean;
- env?: {
- FormData?: new (...args: any[]) => object;
- };
- formSerializer?: FormSerializerOptions;
- family?: AddressFamily;
- lookup?: ((hostname: string, options: object, cb: (err: Error | null, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void) |
- ((hostname: string, options: object) => Promise<[address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily] | LookupAddress>);
- withXSRFToken?: boolean | ((config: InternalAxiosRequestConfig) => boolean | undefined);
- }
- // Alias
- export type RawAxiosRequestConfig<D = any> = AxiosRequestConfig<D>;
- export interface InternalAxiosRequestConfig<D = any> extends AxiosRequestConfig<D> {
- headers: AxiosRequestHeaders;
- }
- export interface HeadersDefaults {
- common: RawAxiosRequestHeaders;
- delete: RawAxiosRequestHeaders;
- get: RawAxiosRequestHeaders;
- head: RawAxiosRequestHeaders;
- post: RawAxiosRequestHeaders;
- put: RawAxiosRequestHeaders;
- patch: RawAxiosRequestHeaders;
- options?: RawAxiosRequestHeaders;
- purge?: RawAxiosRequestHeaders;
- link?: RawAxiosRequestHeaders;
- unlink?: RawAxiosRequestHeaders;
- }
- export interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
- headers: HeadersDefaults;
- }
- export interface CreateAxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
- headers?: RawAxiosRequestHeaders | AxiosHeaders | Partial<HeadersDefaults>;
- }
- export interface AxiosResponse<T = any, D = any> {
- data: T;
- status: number;
- statusText: string;
- headers: RawAxiosResponseHeaders | AxiosResponseHeaders;
- config: InternalAxiosRequestConfig<D>;
- request?: any;
- }
- export class AxiosError<T = unknown, D = any> extends Error {
- constructor(
- message?: string,
- code?: string,
- config?: InternalAxiosRequestConfig<D>,
- request?: any,
- response?: AxiosResponse<T, D>
- );
- config?: InternalAxiosRequestConfig<D>;
- code?: string;
- request?: any;
- response?: AxiosResponse<T, D>;
- isAxiosError: boolean;
- status?: number;
- toJSON: () => object;
- cause?: Error;
- static from<T = unknown, D = any>(
- error: Error | unknown,
- code?: string,
- config?: InternalAxiosRequestConfig<D>,
- request?: any,
- response?: AxiosResponse<T, D>,
- customProps?: object,
- ): AxiosError<T, D>;
- 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_NOT_SUPPORT = "ERR_NOT_SUPPORT";
- static readonly ERR_INVALID_URL = "ERR_INVALID_URL";
- static readonly ERR_CANCELED = "ERR_CANCELED";
- static readonly ECONNABORTED = "ECONNABORTED";
- static readonly ETIMEDOUT = "ETIMEDOUT";
- }
- export class CanceledError<T> extends AxiosError<T> {
- }
- export type AxiosPromise<T = any> = Promise<AxiosResponse<T>>;
- export interface CancelStatic {
- new (message?: string): Cancel;
- }
- export interface Cancel {
- message: string | undefined;
- }
- export interface Canceler {
- (message?: string, config?: AxiosRequestConfig, request?: any): 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: InternalAxiosRequestConfig) => boolean;
- }
- export interface AxiosInterceptorManager<V> {
- use(onFulfilled?: ((value: V) => V | Promise<V>) | null, onRejected?: ((error: any) => any) | null, options?: AxiosInterceptorOptions): number;
- eject(id: number): void;
- clear(): void;
- }
- export class Axios {
- constructor(config?: AxiosRequestConfig);
- defaults: AxiosDefaults;
- interceptors: {
- request: AxiosInterceptorManager<InternalAxiosRequestConfig>;
- 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 {
- <T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>;
- <T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
- defaults: Omit<AxiosDefaults, 'headers'> & {
- headers: HeadersDefaults & {
- [key: string]: AxiosHeaderValue
- }
- };
- }
- export interface GenericFormData {
- append(name: string, value: any, options?: any): any;
- }
- export interface GenericHTMLFormElement {
- name: string;
- method: string;
- submit(): void;
- }
- export function getAdapter(adapters: AxiosAdapterConfig | AxiosAdapterConfig[] | undefined): AxiosAdapter;
- export function toFormData(sourceObj: object, targetFormData?: GenericFormData, options?: FormSerializerOptions): GenericFormData;
- export function formToJSON(form: GenericFormData|GenericHTMLFormElement): object;
- export function isAxiosError<T = any, D = any>(payload: any): payload is AxiosError<T, D>;
- export function spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;
- export function isCancel(value: any): value is Cancel;
- export function all<T>(values: Array<T | Promise<T>>): Promise<T[]>;
- export interface AxiosStatic extends AxiosInstance {
- create(config?: CreateAxiosDefaults): AxiosInstance;
- Cancel: CancelStatic;
- CancelToken: CancelTokenStatic;
- Axios: typeof Axios;
- AxiosError: typeof AxiosError;
- HttpStatusCode: typeof HttpStatusCode;
- readonly VERSION: string;
- isCancel: typeof isCancel;
- all: typeof all;
- spread: typeof spread;
- isAxiosError: typeof isAxiosError;
- toFormData: typeof toFormData;
- formToJSON: typeof formToJSON;
- getAdapter: typeof getAdapter;
- CanceledError: typeof CanceledError;
- AxiosHeaders: typeof AxiosHeaders;
- }
- declare const axios: AxiosStatic;
- export default axios;
|