Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RequestConfig

Hierarchy

  • AxiosRequestConfig
    • RequestConfig

Index

Properties

adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]
auth?: AxiosBasicCredentials
baseURL?: string
cancelToken?: CancelToken
data?: any
decompress?: boolean
env?: { FormData?: (new (...args: any[]) => object) }

Type declaration

  • Optional FormData?: (new (...args: any[]) => object)
      • new (...args: any[]): object
      • Parameters

        • Rest ...args: any[]

        Returns object

formSerializer?: FormSerializerOptions
headers?: AxiosHeaders | Partial<RawAxiosHeaders & { Accept: AxiosHeaderValue; Authorization: AxiosHeaderValue; Content-Encoding: AxiosHeaderValue; Content-Length: AxiosHeaderValue; User-Agent: AxiosHeaderValue } & { Content-Type: ContentType }> & Partial<{ delete: AxiosHeaders; get: AxiosHeaders; head: AxiosHeaders; link: AxiosHeaders; options: AxiosHeaders; patch: AxiosHeaders; post: AxiosHeaders; purge: AxiosHeaders; put: AxiosHeaders; unlink: AxiosHeaders } & { common: AxiosHeaders }>
httpAgent?: any
httpsAgent?: any
insecureHTTPParser?: boolean
lookupField?: string | number
maxBodyLength?: number
maxContentLength?: number
maxRate?: number | [number, number]
maxRedirects?: number
method?: string
params?: any
paramsSerializer?: ParamsSerializerOptions
proxy?: false | AxiosProxyConfig
responseEncoding?: string
responseType?: ResponseType
signal?: GenericAbortSignal
socketPath?: null | string
timeout?: number
timeoutErrorMessage?: string
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]
transitional?: TransitionalOptions
url?: string
validateStatus?: null | ((status: number) => boolean)
withCredentials?: boolean
xsrfCookieName?: string
xsrfHeaderName?: string

Methods

  • beforeRedirect(options: Record<string, any>, responseDetails: { headers: Record<string, string> }): void
  • Parameters

    • options: Record<string, any>
    • responseDetails: { headers: Record<string, string> }
      • headers: Record<string, string>

    Returns void

  • onDownloadProgress(progressEvent: AxiosProgressEvent): void
  • Parameters

    • progressEvent: AxiosProgressEvent

    Returns void

  • onUploadProgress(progressEvent: AxiosProgressEvent): void
  • Parameters

    • progressEvent: AxiosProgressEvent

    Returns void

Generated using TypeDoc