Reference

Classes

axios classes: Axios, AxiosError, AxiosHeaders, Cancel, CancelToken and CanceledError.

Exported classes in the pinned commit e6b79d9cef79.

ClassMembersSummary
AxiosHeaders31—
AxiosError1—
CanceledError0—
Axios13—

AxiosHeaders

Class exported from the pinned source.

MemberReturnsSummary
setAxiosHeaders—
getAxiosHeaderParameters—
hasboolean—
deleteboolean—
clearboolean—
normalizeAxiosHeaders—
concatAxiosHeaders—
toJSONRecord<string, string>—
fromAxiosHeaders—
parseParametersAxiosHeaderParameters—
accessorAxiosHeaders—
setContentTypeAxiosHeaders—
getContentType`RegExpExecArraynull`
hasContentTypeboolean—
setContentLengthAxiosHeaders—
getContentLength`RegExpExecArraynull`
hasContentLengthboolean—
setAcceptAxiosHeaders—
getAccept`RegExpExecArraynull`
hasAcceptboolean—
setUserAgentAxiosHeaders—
getUserAgent`RegExpExecArraynull`
hasUserAgentboolean—
setContentEncodingAxiosHeaders—
getContentEncoding`RegExpExecArraynull`
hasContentEncodingboolean—
setAuthorizationAxiosHeaders—
getAuthorization`RegExpExecArraynull`
hasAuthorizationboolean—
getSetCookiestring[]—
toStringstring—

set

No doc comment in the pinned source.

set(headerName?: string, value?: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders

get

No doc comment in the pinned source.

get(headerName: string, parser: typeof AxiosHeaders.parseParameters): AxiosHeaderParameters

has

No doc comment in the pinned source.

has(header: string, matcher?: AxiosHeaderMatcher): boolean

delete

No doc comment in the pinned source.

delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean

clear

No doc comment in the pinned source.

clear(matcher?: AxiosHeaderMatcher): boolean

normalize

No doc comment in the pinned source.

normalize(format: boolean): AxiosHeaders

concat

No doc comment in the pinned source.

concat(...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>): AxiosHeaders

toJSON

No doc comment in the pinned source.

toJSON(asStrings: true): Record<string, string>

from

No doc comment in the pinned source.

staticfrom(thing?: AxiosHeaders | RawAxiosHeaders | string): AxiosHeaders

parseParameters

No doc comment in the pinned source.

staticparseParameters(value: AxiosHeaderValue): AxiosHeaderParameters

accessor

No doc comment in the pinned source.

staticaccessor(header: string | string[]): AxiosHeaders

setContentType

No doc comment in the pinned source.

setContentType(value: ContentType, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders

getContentType

No doc comment in the pinned source.

getContentType(parser?: RegExp): RegExpExecArray | null

hasContentType

No doc comment in the pinned source.

hasContentType(matcher?: AxiosHeaderMatcher): boolean

setContentLength

No doc comment in the pinned source.

setContentLength(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders

getContentLength

No doc comment in the pinned source.

getContentLength(parser?: RegExp): RegExpExecArray | null

hasContentLength

No doc comment in the pinned source.

hasContentLength(matcher?: AxiosHeaderMatcher): boolean

setAccept

No doc comment in the pinned source.

setAccept(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders

getAccept

No doc comment in the pinned source.

getAccept(parser?: RegExp): RegExpExecArray | null

hasAccept

No doc comment in the pinned source.

hasAccept(matcher?: AxiosHeaderMatcher): boolean

setUserAgent

No doc comment in the pinned source.

setUserAgent(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders

getUserAgent

No doc comment in the pinned source.

getUserAgent(parser?: RegExp): RegExpExecArray | null

hasUserAgent

No doc comment in the pinned source.

hasUserAgent(matcher?: AxiosHeaderMatcher): boolean

setContentEncoding

No doc comment in the pinned source.

setContentEncoding(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders

getContentEncoding

No doc comment in the pinned source.

getContentEncoding(parser?: RegExp): RegExpExecArray | null

hasContentEncoding

No doc comment in the pinned source.

hasContentEncoding(matcher?: AxiosHeaderMatcher): boolean

setAuthorization

No doc comment in the pinned source.

setAuthorization(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders

getAuthorization

No doc comment in the pinned source.

getAuthorization(parser?: RegExp): RegExpExecArray | null

hasAuthorization

No doc comment in the pinned source.

hasAuthorization(matcher?: AxiosHeaderMatcher): boolean

getSetCookie

No doc comment in the pinned source.

getSetCookie(): string[]

toString

No doc comment in the pinned source.

toString(): string

AxiosError

Class exported from the pinned source.

MemberReturnsSummary
fromAxiosError<T, D, P>—

from

No doc comment in the pinned source.

staticfrom(error: Error | unknown, code?: string, config?: InternalAxiosRequestConfig<D, P>, request?: any, response?: AxiosResponse<T, D, {}, P>, customProps?: object): AxiosError<T, D, P>

CanceledError

Class exported from the pinned source.

MemberReturnsSummary

Axios

Class exported from the pinned source.

MemberReturnsSummary
getUristring—
requestPromise<AxiosResponseResult<T, R, D, P>>—
getPromise<AxiosResponseResult<T, R, D, P>>—
deletePromise<AxiosResponseResult<T, R, D, P>>—
headPromise<AxiosResponseResult<T, R, D, P>>—
optionsPromise<AxiosResponseResult<T, R, D, P>>—
postPromise<AxiosResponseResult<T, R, D, P>>—
putPromise<AxiosResponseResult<T, R, D, P>>—
patchPromise<AxiosResponseResult<T, R, D, P>>—
postFormPromise<AxiosResponseResult<T, R, D, P>>—
putFormPromise<AxiosResponseResult<T, R, D, P>>—
patchFormPromise<AxiosResponseResult<T, R, D, P>>—
queryPromise<AxiosResponseResult<T, R, D, P>>—

getUri

No doc comment in the pinned source.

getUri(config?: AxiosRequestConfig): string

request

No doc comment in the pinned source.

request(config: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

get

No doc comment in the pinned source.

get(url: string, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

delete

No doc comment in the pinned source.

delete(url: string, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

No doc comment in the pinned source.

head(url: string, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

options

No doc comment in the pinned source.

options(url: string, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

post

No doc comment in the pinned source.

post(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

put

No doc comment in the pinned source.

put(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

patch

No doc comment in the pinned source.

patch(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

postForm

No doc comment in the pinned source.

postForm(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

putForm

No doc comment in the pinned source.

putForm(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

patchForm

No doc comment in the pinned source.

patchForm(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>

query

No doc comment in the pinned source.

query(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<AxiosResponseResult<T, R, D, P>>