Optionaladapter adapter ?: AxiosAdapterConfig | AxiosAdapterConfig []
Optionalallow allowAbsoluteUrls ?: boolean
Optionalauth auth ?: AxiosBasicCredentials
Optionalbase baseURL ?: string
Optionalbefore beforeRedirect ?: ( options : Record < string , any > , responseDetails : { headers : Record < string , string > ; statusCode : HttpStatusCode ; } , ) => void
Optionalcancel cancelToken ?: CancelToken
Optionaldecompress decompress ?: boolean
Optionaldisable disableAbort ?: boolean
Optionaldisable disableRetry ?: boolean
Optionaldisable disableRetryAPI ?: boolean
Optionaldisable disableRetryByCode ?: string []
Optionalenv env ?: { FormData ?: new ( ... args : any [] ) => object }
Optionalfamily family ?: AddressFamily
Optionalfetch fetchOptions ?: Record < string , any >
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 } , >
Optionalhttp httpAgent ?: any
Optionalhttps httpsAgent ?: any
Optionalinsecure insecureHTTPParser ?: boolean
Optionaljar jar ?: CookieJar
Optionallookup lookup ?: | (( hostname : string , options : object , cb : ( err : null | Error , address : LookupAddress | LookupAddress [] , family ?: AddressFamily , ) => void , ) => void | (( hostname : string , options : object , ) => Promise < | LookupAddress | [ : LookupAddressEntry | LookupAddressEntry [] , ?: AddressFamily , ] , >
Optionalmax maxBodyLength ?: number
Optionalmax maxContentLength ?: number
Optionalmax maxRate ?: number | [ number , number ]
Optionalmax maxRedirects ?: number
Optionalmethod method ?: string
Optionalon onDownloadProgress ?: ( progressEvent : AxiosProgressEvent ) => void
Optionalon onUploadProgress ?: ( progressEvent : AxiosProgressEvent ) => void
Optionalparams params ?: any
Optionalparams paramsSerializer ?: ParamsSerializerOptions | CustomParamsSerializer
Optionalproxy proxy ?: false | AxiosProxyConfig
Optionalresponse responseEncoding ?: string
Optionalresponse responseType ?: ResponseType
Optionalsignal signal ?: GenericAbortSignal
Optionalsocket socketPath ?: null | string
Optionaltimeout timeout ?: number
Optionaltimeout timeoutErrorMessage ?: string
transformRequest ?: AxiosRequestTransformer | AxiosRequestTransformer []
transformResponse ?: AxiosResponseTransformer | AxiosResponseTransformer []
Optionaltransitional transitional ?: TransitionalOptions
Optionaltransport transport ?: any
Optionalvalidate validateStatus ?: null | (( status : number ) => boolean )
Optionalwith withCredentials ?: boolean
Optionalwith withXSRFToken ?: | boolean | (( config : InternalAxiosRequestConfig ) => undefined | boolean )
Optionalxsrf xsrfCookieName ?: string
Configuration options for Mwbot's request methods, extending Axios's request config.
These options are per-request options and should be passed to request methods as needed. To set default options for all requests, provide them in the Mwbot.constructor or update them with Mwbot.setRequestOptions.
When passed to a request method, these options are recursively merged with default options. The priority order is:
where
userRequestOptionsis the options set by the user with the constructor or thesetRequestOptionsmethod. Higher-priority options override lower ones if they share the same properties.