Properties
Optional adapter
Optional auth
Optional baseURL
baseURL?: string
Optional beforeRedirect
beforeRedirect?: ((options, responseDetails) => void)
Type declaration
-
- (options, responseDetails): void
-
Parameters
-
options: Record<string, any>
-
responseDetails: {
headers: Record<string, string>;
}
-
headers: Record<string, string>
Returns void
Optional cancelToken
Optional data
data?: D
Optional decompress
decompress?: boolean
Optional env
env?: {
FormData?: (new (...args) => object);
}
Type declaration
-
Optional FormData?: (new (...args) => object)
-
- new (...args): object
-
Returns object
Optional family
family?: 4 | 6
Optional formSerializer
Optional headers
Optional httpAgent
httpAgent?: any
Optional httpsAgent
httpsAgent?: any
Optional insecureHTTPParser
insecureHTTPParser?: boolean
Optional lookup
lookup?: ((hostname, options, cb) => void) | ((hostname, options) => Promise<string | [address: string, family: number]>)
Type declaration
-
- (hostname, options, cb): void
-
Parameters
-
hostname: string
-
options: object
-
cb: ((err, address, family) => void)
-
- (err, address, family): void
-
Parameters
-
err: null | Error
-
address: string
-
family: number
Returns void
Returns void
Type declaration
-
- (hostname, options): Promise<string | [address: string, family: number]>
-
Parameters
-
hostname: string
-
options: object
Returns Promise<string | [address: string, family: number]>
Optional maxBodyLength
maxBodyLength?: number
Optional maxContentLength
maxContentLength?: number
Optional maxRate
maxRate?: number | [number, number]
Optional maxRedirects
maxRedirects?: number
Optional method
method?: string
Optional onDownloadProgress
onDownloadProgress?: ((progressEvent) => void)
Type declaration
-
- (progressEvent): void
-
Returns void
Optional onUploadProgress
onUploadProgress?: ((progressEvent) => void)
Type declaration
-
- (progressEvent): void
-
Returns void
Optional params
params?: any
Optional paramsSerializer
Optional proxy
Optional responseEncoding
responseEncoding?: string
Optional responseType
Optional signal
Optional socketPath
socketPath?: null | string
Optional timeout
timeout?: number
Optional timeoutErrorMessage
timeoutErrorMessage?: string
Optional transformRequest
Optional transformResponse
Optional transitional
Optional transport
transport?: any
Optional url
url?: string
Optional validateStatus
validateStatus?: null | ((status) => boolean)
Type declaration
-
- (status): boolean
-
Returns boolean
Optional withCredentials
withCredentials?: boolean
Optional xsrfCookieName
xsrfCookieName?: string
Optional xsrfHeaderName
xsrfHeaderName?: string