From 9d11ad731e1a7dc6301613192fc2a4c5b2a02d13 Mon Sep 17 00:00:00 2001 From: aiselp Date: Tue, 16 Jul 2024 14:57:30 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=A0=E9=99=A4=E8=87=AA=E5=8A=A8=E7=94=9F?= =?UTF-8?q?=E6=88=90=E7=9A=84=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/nodejs/docs/README.md | 24 +- docs/nodejs/docs/axios.md | 8232 ------------------------------ docs/nodejs/docs/clip_manager.md | 83 - docs/nodejs/docs/java.md | 140 - docs/nodejs/docs/media.md | 354 -- docusaurus.config.ts | 2 +- src/pages/index.tsx | 5 + 7 files changed, 7 insertions(+), 8833 deletions(-) delete mode 100644 docs/nodejs/docs/axios.md delete mode 100644 docs/nodejs/docs/clip_manager.md delete mode 100644 docs/nodejs/docs/java.md delete mode 100644 docs/nodejs/docs/media.md diff --git a/docs/nodejs/docs/README.md b/docs/nodejs/docs/README.md index dad3d3b..2b37d7f 100644 --- a/docs/nodejs/docs/README.md +++ b/docs/nodejs/docs/README.md @@ -2,26 +2,4 @@ 这里是第二代 api 模块，这些模块全部使用 ts 编写 -## 如何构建？ - -首先运行`npm install`安装所有依赖项 - -- 构建模块 - -```js -npm run build -``` - -- 构建文档 - -```js -npm run docs -``` - -## Modules - -- [axios](axios.md) -- [clip\_manager](clip_manager.md) -- [java](java.md) -- [media](media.md) -- [toast](toast.md) +此目录下为自动生成文档存放位置 diff --git a/docs/nodejs/docs/axios.md b/docs/nodejs/docs/axios.md deleted file mode 100644 index 0770d99..0000000 --- a/docs/nodejs/docs/axios.md +++ /dev/null @@ -1,8232 +0,0 @@ -# axios - -## Enumerations - -### HttpStatusCode - -#### Enumeration Members - -##### Accepted - -```ts -Accepted: 202; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:135 - -##### AlreadyReported - -```ts -AlreadyReported: 208; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:141 - -##### BadGateway - -```ts -BadGateway: 502; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:183 - -##### BadRequest - -```ts -BadRequest: 400; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:152 - -##### Conflict - -```ts -Conflict: 409; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:161 - -##### Continue - -```ts -Continue: 100; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:129 - -##### Created - -```ts -Created: 201; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:134 - -##### EarlyHints - -```ts -EarlyHints: 103; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:132 - -##### ExpectationFailed - -```ts -ExpectationFailed: 417; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:169 - -##### FailedDependency - -```ts -FailedDependency: 424; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:174 - -##### Forbidden - -```ts -Forbidden: 403; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:155 - -##### Found - -```ts -Found: 302; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:145 - -##### GatewayTimeout - -```ts -GatewayTimeout: 504; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:185 - -##### Gone - -```ts -Gone: 410; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:162 - -##### HttpVersionNotSupported - -```ts -HttpVersionNotSupported: 505; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:186 - -##### ImATeapot - -```ts -ImATeapot: 418; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:170 - -##### ImUsed - -```ts -ImUsed: 226; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:142 - -##### InsufficientStorage - -```ts -InsufficientStorage: 507; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:188 - -##### InternalServerError - -```ts -InternalServerError: 500; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:181 - -##### LengthRequired - -```ts -LengthRequired: 411; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:163 - -##### Locked - -```ts -Locked: 423; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:173 - -##### LoopDetected - -```ts -LoopDetected: 508; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:189 - -##### MethodNotAllowed - -```ts -MethodNotAllowed: 405; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:157 - -##### MisdirectedRequest - -```ts -MisdirectedRequest: 421; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:171 - -##### MovedPermanently - -```ts -MovedPermanently: 301; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:144 - -##### MultiStatus - -```ts -MultiStatus: 207; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:140 - -##### MultipleChoices - -```ts -MultipleChoices: 300; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:143 - -##### NetworkAuthenticationRequired - -```ts -NetworkAuthenticationRequired: 511; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:191 - -##### NoContent - -```ts -NoContent: 204; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:137 - -##### NonAuthoritativeInformation - -```ts -NonAuthoritativeInformation: 203; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:136 - -##### NotAcceptable - -```ts -NotAcceptable: 406; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:158 - -##### NotExtended - -```ts -NotExtended: 510; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:190 - -##### NotFound - -```ts -NotFound: 404; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:156 - -##### NotImplemented - -```ts -NotImplemented: 501; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:182 - -##### NotModified - -```ts -NotModified: 304; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:147 - -##### Ok - -```ts -Ok: 200; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:133 - -##### PartialContent - -```ts -PartialContent: 206; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:139 - -##### PayloadTooLarge - -```ts -PayloadTooLarge: 413; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:165 - -##### PaymentRequired - -```ts -PaymentRequired: 402; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:154 - -##### PermanentRedirect - -```ts -PermanentRedirect: 308; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:151 - -##### PreconditionFailed - -```ts -PreconditionFailed: 412; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:164 - -##### PreconditionRequired - -```ts -PreconditionRequired: 428; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:177 - -##### Processing - -```ts -Processing: 102; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:131 - -##### ProxyAuthenticationRequired - -```ts -ProxyAuthenticationRequired: 407; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:159 - -##### RangeNotSatisfiable - -```ts -RangeNotSatisfiable: 416; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:168 - -##### RequestHeaderFieldsTooLarge - -```ts -RequestHeaderFieldsTooLarge: 431; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:179 - -##### RequestTimeout - -```ts -RequestTimeout: 408; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:160 - -##### ResetContent - -```ts -ResetContent: 205; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:138 - -##### SeeOther - -```ts -SeeOther: 303; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:146 - -##### ServiceUnavailable - -```ts -ServiceUnavailable: 503; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:184 - -##### SwitchingProtocols - -```ts -SwitchingProtocols: 101; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:130 - -##### TemporaryRedirect - -```ts -TemporaryRedirect: 307; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:150 - -##### TooEarly - -```ts -TooEarly: 425; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:175 - -##### TooManyRequests - -```ts -TooManyRequests: 429; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:178 - -##### Unauthorized - -```ts -Unauthorized: 401; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:153 - -##### UnavailableForLegalReasons - -```ts -UnavailableForLegalReasons: 451; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:180 - -##### UnprocessableEntity - -```ts -UnprocessableEntity: 422; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:172 - -##### UnsupportedMediaType - -```ts -UnsupportedMediaType: 415; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:167 - -##### Unused - -```ts -Unused: 306; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:149 - -##### UpgradeRequired - -```ts -UpgradeRequired: 426; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:176 - -##### UriTooLong - -```ts -UriTooLong: 414; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:166 - -##### UseProxy - -```ts -UseProxy: 305; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:148 - -##### VariantAlsoNegotiates - -```ts -VariantAlsoNegotiates: 506; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:187 - -## Classes - -### Axios - -#### Extended by - -- [`AxiosInstance`](axios.md#axiosinstance) - -#### Constructors - -##### new Axios() - -```ts -new Axios(config?: AxiosRequestConfig): Axios -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`any`\> | - -###### Returns - -[`Axios`](axios.md#axios) - -###### Defined in - -node\_modules/axios/index.d.ts:486 - -#### Properties - -##### defaults - -```ts -defaults: AxiosDefaults; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:487 - -##### interceptors - -```ts -interceptors: object; -``` - -###### request - -```ts -request: AxiosInterceptorManager>; -``` - -###### response - -```ts -response: AxiosInterceptorManager>; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:488 - -#### Methods - -##### delete() - -```ts -delete(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:495 - -##### get() - -```ts -get(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:494 - -##### getUri() - -```ts -getUri(config?: AxiosRequestConfig): string -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`any`\> | - -###### Returns - -`string` - -###### Defined in - -node\_modules/axios/index.d.ts:492 - -##### head() - -```ts -head(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:496 - -##### options() - -```ts -options(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:497 - -##### patch() - -```ts -patch( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:500 - -##### patchForm() - -```ts -patchForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:503 - -##### post() - -```ts -post( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:498 - -##### postForm() - -```ts -postForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:501 - -##### put() - -```ts -put( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:499 - -##### putForm() - -```ts -putForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:502 - -##### request() - -```ts -request(config: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Defined in - -node\_modules/axios/index.d.ts:493 - -*** - -### AxiosError\ - -#### Extends - -- `Error` - -#### Extended by - -- [`CanceledError`](axios.md#cancelederrort) - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `unknown` | -| `D` | `any` | - -#### Constructors - -##### new AxiosError() - -```ts -new AxiosError( - message?: string, - code?: string, - config?: InternalAxiosRequestConfig, - request?: any, -response?: AxiosResponse): AxiosError -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `message`? | `string` | -| `code`? | `string` | -| `config`? | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`D`\> | -| `request`? | `any` | -| `response`? | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `D`\> | - -###### Returns - -[`AxiosError`](axios.md#axioserrortd)\<`T`, `D`\> - -###### Overrides - -`Error.constructor` - -###### Defined in - -node\_modules/axios/index.d.ts:403 - -#### Properties - -##### cause? - -```ts -optional cause: Error; -``` - -###### Overrides - -`Error.cause` - -###### Defined in - -node\_modules/axios/index.d.ts:418 - -##### code? - -```ts -optional code: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:412 - -##### config? - -```ts -optional config: InternalAxiosRequestConfig; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:411 - -##### isAxiosError - -```ts -isAxiosError: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:415 - -##### message - -```ts -message: string; -``` - -###### Inherited from - -`Error.message` - -###### Defined in - -node\_modules/typescript/lib/lib.es5.d.ts:1077 - -##### name - -```ts -name: string; -``` - -###### Inherited from - -`Error.name` - -###### Defined in - -node\_modules/typescript/lib/lib.es5.d.ts:1076 - -##### request? - -```ts -optional request: any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:413 - -##### response? - -```ts -optional response: AxiosResponse; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:414 - -##### stack? - -```ts -optional stack: string; -``` - -###### Inherited from - -`Error.stack` - -###### Defined in - -node\_modules/typescript/lib/lib.es5.d.ts:1078 - -##### status? - -```ts -optional status: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:416 - -##### toJSON() - -```ts -toJSON: () => object; -``` - -###### Returns - -`object` - -###### Defined in - -node\_modules/axios/index.d.ts:417 - -##### ECONNABORTED - -```ts -readonly static ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:437 - -##### ERR\_BAD\_OPTION - -```ts -readonly static ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:429 - -##### ERR\_BAD\_OPTION\_VALUE - -```ts -readonly static ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:428 - -##### ERR\_BAD\_REQUEST - -```ts -readonly static ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:433 - -##### ERR\_BAD\_RESPONSE - -```ts -readonly static ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:432 - -##### ERR\_CANCELED - -```ts -readonly static ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:436 - -##### ERR\_DEPRECATED - -```ts -readonly static ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:431 - -##### ERR\_FR\_TOO\_MANY\_REDIRECTS - -```ts -readonly static ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:427 - -##### ERR\_INVALID\_URL - -```ts -readonly static ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:435 - -##### ERR\_NETWORK - -```ts -readonly static ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:430 - -##### ERR\_NOT\_SUPPORT - -```ts -readonly static ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:434 - -##### ETIMEDOUT - -```ts -readonly static ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:438 - -##### prepareStackTrace()? - -```ts -static optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any; -``` - -Optional override for formatting stack traces - -###### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -###### Returns - -`any` - -###### Inherited from - -`Error.prepareStackTrace` - -###### Defined in - -node\_modules/@types/node/globals.d.ts:28 - -##### stackTraceLimit - -```ts -static stackTraceLimit: number; -``` - -###### Inherited from - -`Error.stackTraceLimit` - -###### Defined in - -node\_modules/@types/node/globals.d.ts:30 - -#### Methods - -##### captureStackTrace() - -```ts -static captureStackTrace(targetObject: object, constructorOpt?: Function): void -``` - -Create .stack property on a target object - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt`? | `Function` | - -###### Returns - -`void` - -###### Inherited from - -`Error.captureStackTrace` - -###### Defined in - -node\_modules/@types/node/globals.d.ts:21 - -##### from() - -```ts -static from( - error: unknown, - code?: string, - config?: InternalAxiosRequestConfig, - request?: any, - response?: AxiosResponse, -customProps?: object): AxiosError -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `unknown` | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `unknown` | -| `code`? | `string` | -| `config`? | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`D`\> | -| `request`? | `any` | -| `response`? | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `D`\> | -| `customProps`? | `object` | - -###### Returns - -[`AxiosError`](axios.md#axioserrortd)\<`T`, `D`\> - -###### Defined in - -node\_modules/axios/index.d.ts:419 - -*** - -### AxiosHeaders - -#### Indexable - - \[`key`: `string`\]: `any` - -#### Constructors - -##### new AxiosHeaders() - -```ts -new AxiosHeaders(headers?: string | AxiosHeaders | RawAxiosHeaders): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `headers`? | `string` \| [`AxiosHeaders`](axios.md#axiosheaders) \| `RawAxiosHeaders` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:17 - -#### Methods - -##### \[iterator\]() - -```ts -iterator: IterableIterator<[string, AxiosHeaderValue]> -``` - -###### Returns - -`IterableIterator`\<[`string`, [`AxiosHeaderValue`](axios.md#axiosheadervalue)]\> - -###### Defined in - -node\_modules/axios/index.d.ts:77 - -##### clear() - -```ts -clear(matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:33 - -##### concat() - -```ts -concat(...targets: ( - | undefined - | null - | string - | AxiosHeaders - | RawAxiosHeaders)[]): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`targets` | ( \| `undefined` \| `null` \| `string` \| [`AxiosHeaders`](axios.md#axiosheaders) \| `RawAxiosHeaders`)[] | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:37 - -##### delete() - -```ts -delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `header` | `string` \| `string`[] | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:31 - -##### get() - -###### get(headerName, parser) - -```ts -get(headerName: string, parser: RegExp): null | RegExpExecArray -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `headerName` | `string` | -| `parser` | `RegExp` | - -###### Returns - -`null` \| `RegExpExecArray` - -###### Defined in - -node\_modules/axios/index.d.ts:26 - -###### get(headerName, matcher) - -```ts -get(headerName: string, matcher?: true | AxiosHeaderParser): AxiosHeaderValue -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `headerName` | `string` | -| `matcher`? | `true` \| `AxiosHeaderParser` | - -###### Returns - -[`AxiosHeaderValue`](axios.md#axiosheadervalue) - -###### Defined in - -node\_modules/axios/index.d.ts:27 - -##### getAccept() - -###### getAccept(parser) - -```ts -getAccept(parser?: RegExp): null | RegExpExecArray -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `parser`? | `RegExp` | - -###### Returns - -`null` \| `RegExpExecArray` - -###### Defined in - -node\_modules/axios/index.d.ts:58 - -###### getAccept(matcher) - -```ts -getAccept(matcher?: AxiosHeaderMatcher): AxiosHeaderValue -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaderValue`](axios.md#axiosheadervalue) - -###### Defined in - -node\_modules/axios/index.d.ts:59 - -##### getAuthorization() - -###### getAuthorization(parser) - -```ts -getAuthorization(parser?: RegExp): null | RegExpExecArray -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `parser`? | `RegExp` | - -###### Returns - -`null` \| `RegExpExecArray` - -###### Defined in - -node\_modules/axios/index.d.ts:73 - -###### getAuthorization(matcher) - -```ts -getAuthorization(matcher?: AxiosHeaderMatcher): AxiosHeaderValue -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaderValue`](axios.md#axiosheadervalue) - -###### Defined in - -node\_modules/axios/index.d.ts:74 - -##### getContentEncoding() - -###### getContentEncoding(parser) - -```ts -getContentEncoding(parser?: RegExp): null | RegExpExecArray -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `parser`? | `RegExp` | - -###### Returns - -`null` \| `RegExpExecArray` - -###### Defined in - -node\_modules/axios/index.d.ts:68 - -###### getContentEncoding(matcher) - -```ts -getContentEncoding(matcher?: AxiosHeaderMatcher): AxiosHeaderValue -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaderValue`](axios.md#axiosheadervalue) - -###### Defined in - -node\_modules/axios/index.d.ts:69 - -##### getContentLength() - -###### getContentLength(parser) - -```ts -getContentLength(parser?: RegExp): null | RegExpExecArray -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `parser`? | `RegExp` | - -###### Returns - -`null` \| `RegExpExecArray` - -###### Defined in - -node\_modules/axios/index.d.ts:53 - -###### getContentLength(matcher) - -```ts -getContentLength(matcher?: AxiosHeaderMatcher): AxiosHeaderValue -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaderValue`](axios.md#axiosheadervalue) - -###### Defined in - -node\_modules/axios/index.d.ts:54 - -##### getContentType() - -###### getContentType(parser) - -```ts -getContentType(parser?: RegExp): null | RegExpExecArray -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `parser`? | `RegExp` | - -###### Returns - -`null` \| `RegExpExecArray` - -###### Defined in - -node\_modules/axios/index.d.ts:48 - -###### getContentType(matcher) - -```ts -getContentType(matcher?: AxiosHeaderMatcher): AxiosHeaderValue -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaderValue`](axios.md#axiosheadervalue) - -###### Defined in - -node\_modules/axios/index.d.ts:49 - -##### getUserAgent() - -###### getUserAgent(parser) - -```ts -getUserAgent(parser?: RegExp): null | RegExpExecArray -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `parser`? | `RegExp` | - -###### Returns - -`null` \| `RegExpExecArray` - -###### Defined in - -node\_modules/axios/index.d.ts:63 - -###### getUserAgent(matcher) - -```ts -getUserAgent(matcher?: AxiosHeaderMatcher): AxiosHeaderValue -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaderValue`](axios.md#axiosheadervalue) - -###### Defined in - -node\_modules/axios/index.d.ts:64 - -##### has() - -```ts -has(header: string, matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `header` | `string` | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:29 - -##### hasAccept() - -```ts -hasAccept(matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:60 - -##### hasAuthorization() - -```ts -hasAuthorization(matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:75 - -##### hasContentEncoding() - -```ts -hasContentEncoding(matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:70 - -##### hasContentLength() - -```ts -hasContentLength(matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:55 - -##### hasContentType() - -```ts -hasContentType(matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:50 - -##### hasUserAgent() - -```ts -hasUserAgent(matcher?: AxiosHeaderMatcher): boolean -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `matcher`? | `AxiosHeaderMatcher` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:65 - -##### normalize() - -```ts -normalize(format: boolean): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `format` | `boolean` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:35 - -##### set() - -###### set(headerName, value, rewrite) - -```ts -set( - headerName?: string, - value?: AxiosHeaderValue, - rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `headerName`? | `string` | -| `value`? | [`AxiosHeaderValue`](axios.md#axiosheadervalue) | -| `rewrite`? | `boolean` \| `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:23 - -###### set(headers, rewrite) - -```ts -set(headers?: string | AxiosHeaders | RawAxiosHeaders, rewrite?: boolean): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `headers`? | `string` \| [`AxiosHeaders`](axios.md#axiosheaders) \| `RawAxiosHeaders` | -| `rewrite`? | `boolean` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:24 - -##### setAccept() - -```ts -setAccept(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | [`AxiosHeaderValue`](axios.md#axiosheadervalue) | -| `rewrite`? | `boolean` \| `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:57 - -##### setAuthorization() - -```ts -setAuthorization(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | [`AxiosHeaderValue`](axios.md#axiosheadervalue) | -| `rewrite`? | `boolean` \| `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:72 - -##### setContentEncoding() - -```ts -setContentEncoding(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | [`AxiosHeaderValue`](axios.md#axiosheadervalue) | -| `rewrite`? | `boolean` \| `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:67 - -##### setContentLength() - -```ts -setContentLength(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | [`AxiosHeaderValue`](axios.md#axiosheadervalue) | -| `rewrite`? | `boolean` \| `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:52 - -##### setContentType() - -```ts -setContentType(value: ContentType, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | `ContentType` | -| `rewrite`? | `boolean` \| `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:47 - -##### setUserAgent() - -```ts -setUserAgent(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | [`AxiosHeaderValue`](axios.md#axiosheadervalue) | -| `rewrite`? | `boolean` \| `AxiosHeaderMatcher` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:62 - -##### toJSON() - -```ts -toJSON(asStrings?: boolean): RawAxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `asStrings`? | `boolean` | - -###### Returns - -`RawAxiosHeaders` - -###### Defined in - -node\_modules/axios/index.d.ts:39 - -##### accessor() - -```ts -static accessor(header: string | string[]): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `header` | `string` \| `string`[] | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:43 - -##### concat() - -```ts -static concat(...targets: ( - | undefined - | null - | string - | AxiosHeaders - | RawAxiosHeaders)[]): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`targets` | ( \| `undefined` \| `null` \| `string` \| [`AxiosHeaders`](axios.md#axiosheaders) \| `RawAxiosHeaders`)[] | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:45 - -##### from() - -```ts -static from(thing?: string | AxiosHeaders | RawAxiosHeaders): AxiosHeaders -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `thing`? | `string` \| [`AxiosHeaders`](axios.md#axiosheaders) \| `RawAxiosHeaders` | - -###### Returns - -[`AxiosHeaders`](axios.md#axiosheaders) - -###### Defined in - -node\_modules/axios/index.d.ts:41 - -*** - -### CanceledError\ - -#### Extends - -- [`AxiosError`](axios.md#axioserrortd)\<`T`\> - -#### Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -#### Constructors - -##### new CanceledError() - -```ts -new CanceledError( - message?: string, - code?: string, - config?: InternalAxiosRequestConfig, - request?: any, -response?: AxiosResponse): CanceledError -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `message`? | `string` | -| `code`? | `string` | -| `config`? | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`any`\> | -| `request`? | `any` | -| `response`? | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | - -###### Returns - -[`CanceledError`](axios.md#cancelederrort)\<`T`\> - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`constructor`](axios.md#constructors-1) - -###### Defined in - -node\_modules/axios/index.d.ts:403 - -#### Properties - -##### cause? - -```ts -optional cause: Error; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`cause`](axios.md#cause) - -###### Defined in - -node\_modules/axios/index.d.ts:418 - -##### code? - -```ts -optional code: string; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`code`](axios.md#code) - -###### Defined in - -node\_modules/axios/index.d.ts:412 - -##### config? - -```ts -optional config: InternalAxiosRequestConfig; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`config`](axios.md#config) - -###### Defined in - -node\_modules/axios/index.d.ts:411 - -##### isAxiosError - -```ts -isAxiosError: boolean; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`isAxiosError`](axios.md#isaxioserror) - -###### Defined in - -node\_modules/axios/index.d.ts:415 - -##### message - -```ts -message: string; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`message`](axios.md#message) - -###### Defined in - -node\_modules/typescript/lib/lib.es5.d.ts:1077 - -##### name - -```ts -name: string; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`name`](axios.md#name) - -###### Defined in - -node\_modules/typescript/lib/lib.es5.d.ts:1076 - -##### request? - -```ts -optional request: any; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`request`](axios.md#request-2) - -###### Defined in - -node\_modules/axios/index.d.ts:413 - -##### response? - -```ts -optional response: AxiosResponse; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`response`](axios.md#response-1) - -###### Defined in - -node\_modules/axios/index.d.ts:414 - -##### stack? - -```ts -optional stack: string; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`stack`](axios.md#stack) - -###### Defined in - -node\_modules/typescript/lib/lib.es5.d.ts:1078 - -##### status? - -```ts -optional status: number; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`status`](axios.md#status) - -###### Defined in - -node\_modules/axios/index.d.ts:416 - -##### toJSON() - -```ts -toJSON: () => object; -``` - -###### Returns - -`object` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`toJSON`](axios.md#tojson) - -###### Defined in - -node\_modules/axios/index.d.ts:417 - -##### ECONNABORTED - -```ts -readonly static ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ECONNABORTED`](axios.md#econnaborted) - -###### Defined in - -node\_modules/axios/index.d.ts:437 - -##### ERR\_BAD\_OPTION - -```ts -readonly static ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_BAD_OPTION`](axios.md#err_bad_option) - -###### Defined in - -node\_modules/axios/index.d.ts:429 - -##### ERR\_BAD\_OPTION\_VALUE - -```ts -readonly static ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_BAD_OPTION_VALUE`](axios.md#err_bad_option_value) - -###### Defined in - -node\_modules/axios/index.d.ts:428 - -##### ERR\_BAD\_REQUEST - -```ts -readonly static ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_BAD_REQUEST`](axios.md#err_bad_request) - -###### Defined in - -node\_modules/axios/index.d.ts:433 - -##### ERR\_BAD\_RESPONSE - -```ts -readonly static ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_BAD_RESPONSE`](axios.md#err_bad_response) - -###### Defined in - -node\_modules/axios/index.d.ts:432 - -##### ERR\_CANCELED - -```ts -readonly static ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_CANCELED`](axios.md#err_canceled) - -###### Defined in - -node\_modules/axios/index.d.ts:436 - -##### ERR\_DEPRECATED - -```ts -readonly static ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_DEPRECATED`](axios.md#err_deprecated) - -###### Defined in - -node\_modules/axios/index.d.ts:431 - -##### ERR\_FR\_TOO\_MANY\_REDIRECTS - -```ts -readonly static ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_FR_TOO_MANY_REDIRECTS`](axios.md#err_fr_too_many_redirects) - -###### Defined in - -node\_modules/axios/index.d.ts:427 - -##### ERR\_INVALID\_URL - -```ts -readonly static ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_INVALID_URL`](axios.md#err_invalid_url) - -###### Defined in - -node\_modules/axios/index.d.ts:435 - -##### ERR\_NETWORK - -```ts -readonly static ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_NETWORK`](axios.md#err_network) - -###### Defined in - -node\_modules/axios/index.d.ts:430 - -##### ERR\_NOT\_SUPPORT - -```ts -readonly static ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ERR_NOT_SUPPORT`](axios.md#err_not_support) - -###### Defined in - -node\_modules/axios/index.d.ts:434 - -##### ETIMEDOUT - -```ts -readonly static ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`ETIMEDOUT`](axios.md#etimedout) - -###### Defined in - -node\_modules/axios/index.d.ts:438 - -##### prepareStackTrace()? - -```ts -static optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any; -``` - -Optional override for formatting stack traces - -###### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -###### Returns - -`any` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`prepareStackTrace`](axios.md#preparestacktrace) - -###### Defined in - -node\_modules/@types/node/globals.d.ts:28 - -##### stackTraceLimit - -```ts -static stackTraceLimit: number; -``` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`stackTraceLimit`](axios.md#stacktracelimit) - -###### Defined in - -node\_modules/@types/node/globals.d.ts:30 - -#### Methods - -##### captureStackTrace() - -```ts -static captureStackTrace(targetObject: object, constructorOpt?: Function): void -``` - -Create .stack property on a target object - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt`? | `Function` | - -###### Returns - -`void` - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`captureStackTrace`](axios.md#capturestacktrace) - -###### Defined in - -node\_modules/@types/node/globals.d.ts:21 - -##### from() - -```ts -static from( - error: unknown, - code?: string, - config?: InternalAxiosRequestConfig, - request?: any, - response?: AxiosResponse, -customProps?: object): AxiosError -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `unknown` | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `unknown` | -| `code`? | `string` | -| `config`? | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`D`\> | -| `request`? | `any` | -| `response`? | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `D`\> | -| `customProps`? | `object` | - -###### Returns - -[`AxiosError`](axios.md#axioserrortd)\<`T`, `D`\> - -###### Inherited from - -[`AxiosError`](axios.md#axioserrortd).[`from`](axios.md#from) - -###### Defined in - -node\_modules/axios/index.d.ts:419 - -## Interfaces - -### AxiosAdapter() - -```ts -interface AxiosAdapter(config: InternalAxiosRequestConfig): AxiosPromise -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`any`\> | - -#### Returns - -[`AxiosPromise`](axios.md#axiospromiset)\<`any`\> - -#### Defined in - -node\_modules/axios/index.d.ts:113 - -*** - -### AxiosBasicCredentials - -#### Properties - -##### password - -```ts -password: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:118 - -##### username - -```ts -username: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:117 - -*** - -### AxiosDefaults\ - -#### Extends - -- `Omit`\<[`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\>, `"headers"`\> - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `D` | `any` | - -#### Properties - -##### adapter? - -```ts -optional adapter: AxiosAdapterConfig | AxiosAdapterConfig[]; -``` - -###### Inherited from - -`Omit.adapter` - -###### Defined in - -node\_modules/axios/index.d.ts:329 - -##### auth? - -```ts -optional auth: AxiosBasicCredentials; -``` - -###### Inherited from - -`Omit.auth` - -###### Defined in - -node\_modules/axios/index.d.ts:330 - -##### baseURL? - -```ts -optional baseURL: string; -``` - -###### Inherited from - -`Omit.baseURL` - -###### Defined in - -node\_modules/axios/index.d.ts:319 - -##### beforeRedirect()? - -```ts -optional beforeRedirect: (options: Record, responseDetails: object) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `options` | `Record`\<`string`, `any`\> | -| `responseDetails` | `object` | -| `responseDetails.headers` | `Record`\<`string`, `string`\> | -| `responseDetails.statusCode` | [`HttpStatusCode`](axios.md#httpstatuscode) | - -###### Returns - -`void` - -###### Inherited from - -`Omit.beforeRedirect` - -###### Defined in - -node\_modules/axios/index.d.ts:342 - -##### cancelToken? - -```ts -optional cancelToken: CancelToken; -``` - -###### Inherited from - -`Omit.cancelToken` - -###### Defined in - -node\_modules/axios/index.d.ts:348 - -##### data? - -```ts -optional data: D; -``` - -###### Inherited from - -`Omit.data` - -###### Defined in - -node\_modules/axios/index.d.ts:325 - -##### decompress? - -```ts -optional decompress: boolean; -``` - -###### Inherited from - -`Omit.decompress` - -###### Defined in - -node\_modules/axios/index.d.ts:349 - -##### env? - -```ts -optional env: object; -``` - -###### FormData()? - -```ts -optional FormData: (...args: any[]) => object; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`args` | `any`[] | - -###### Returns - -`object` - -###### Inherited from - -`Omit.env` - -###### Defined in - -node\_modules/axios/index.d.ts:353 - -##### family? - -```ts -optional family: AddressFamily; -``` - -###### Inherited from - -`Omit.family` - -###### Defined in - -node\_modules/axios/index.d.ts:357 - -##### fetchOptions? - -```ts -optional fetchOptions: Record; -``` - -###### Inherited from - -`Omit.fetchOptions` - -###### Defined in - -node\_modules/axios/index.d.ts:361 - -##### formSerializer? - -```ts -optional formSerializer: FormSerializerOptions; -``` - -###### Inherited from - -`Omit.formSerializer` - -###### Defined in - -node\_modules/axios/index.d.ts:356 - -##### headers - -```ts -headers: HeadersDefaults; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:386 - -##### httpAgent? - -```ts -optional httpAgent: any; -``` - -###### Inherited from - -`Omit.httpAgent` - -###### Defined in - -node\_modules/axios/index.d.ts:345 - -##### httpsAgent? - -```ts -optional httpsAgent: any; -``` - -###### Inherited from - -`Omit.httpsAgent` - -###### Defined in - -node\_modules/axios/index.d.ts:346 - -##### insecureHTTPParser? - -```ts -optional insecureHTTPParser: boolean; -``` - -###### Inherited from - -`Omit.insecureHTTPParser` - -###### Defined in - -node\_modules/axios/index.d.ts:352 - -##### lookup? - -```ts -optional lookup: (hostname: string, options: object, cb: (err: null | Error, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void | (hostname: string, options: object) => Promise; -``` - -###### Inherited from - -`Omit.lookup` - -###### Defined in - -node\_modules/axios/index.d.ts:358 - -##### maxBodyLength? - -```ts -optional maxBodyLength: number; -``` - -###### Inherited from - -`Omit.maxBodyLength` - -###### Defined in - -node\_modules/axios/index.d.ts:339 - -##### maxContentLength? - -```ts -optional maxContentLength: number; -``` - -###### Inherited from - -`Omit.maxContentLength` - -###### Defined in - -node\_modules/axios/index.d.ts:337 - -##### maxRate? - -```ts -optional maxRate: number | [number, number]; -``` - -###### Inherited from - -`Omit.maxRate` - -###### Defined in - -node\_modules/axios/index.d.ts:341 - -##### maxRedirects? - -```ts -optional maxRedirects: number; -``` - -###### Inherited from - -`Omit.maxRedirects` - -###### Defined in - -node\_modules/axios/index.d.ts:340 - -##### method? - -```ts -optional method: string; -``` - -###### Inherited from - -`Omit.method` - -###### Defined in - -node\_modules/axios/index.d.ts:318 - -##### onDownloadProgress()? - -```ts -optional onDownloadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Inherited from - -`Omit.onDownloadProgress` - -###### Defined in - -node\_modules/axios/index.d.ts:336 - -##### onUploadProgress()? - -```ts -optional onUploadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Inherited from - -`Omit.onUploadProgress` - -###### Defined in - -node\_modules/axios/index.d.ts:335 - -##### params? - -```ts -optional params: any; -``` - -###### Inherited from - -`Omit.params` - -###### Defined in - -node\_modules/axios/index.d.ts:323 - -##### paramsSerializer? - -```ts -optional paramsSerializer: CustomParamsSerializer | ParamsSerializerOptions; -``` - -###### Inherited from - -`Omit.paramsSerializer` - -###### Defined in - -node\_modules/axios/index.d.ts:324 - -##### proxy? - -```ts -optional proxy: false | AxiosProxyConfig; -``` - -###### Inherited from - -`Omit.proxy` - -###### Defined in - -node\_modules/axios/index.d.ts:347 - -##### responseEncoding? - -```ts -optional responseEncoding: string; -``` - -###### Inherited from - -`Omit.responseEncoding` - -###### Defined in - -node\_modules/axios/index.d.ts:332 - -##### responseType? - -```ts -optional responseType: ResponseType; -``` - -###### Inherited from - -`Omit.responseType` - -###### Defined in - -node\_modules/axios/index.d.ts:331 - -##### signal? - -```ts -optional signal: GenericAbortSignal; -``` - -###### Inherited from - -`Omit.signal` - -###### Defined in - -node\_modules/axios/index.d.ts:351 - -##### socketPath? - -```ts -optional socketPath: null | string; -``` - -###### Inherited from - -`Omit.socketPath` - -###### Defined in - -node\_modules/axios/index.d.ts:343 - -##### timeout? - -```ts -optional timeout: number; -``` - -###### Inherited from - -`Omit.timeout` - -###### Defined in - -node\_modules/axios/index.d.ts:326 - -##### timeoutErrorMessage? - -```ts -optional timeoutErrorMessage: string; -``` - -###### Inherited from - -`Omit.timeoutErrorMessage` - -###### Defined in - -node\_modules/axios/index.d.ts:327 - -##### transformRequest? - -```ts -optional transformRequest: AxiosRequestTransformer | AxiosRequestTransformer[]; -``` - -###### Inherited from - -`Omit.transformRequest` - -###### Defined in - -node\_modules/axios/index.d.ts:320 - -##### transformResponse? - -```ts -optional transformResponse: AxiosResponseTransformer | AxiosResponseTransformer[]; -``` - -###### Inherited from - -`Omit.transformResponse` - -###### Defined in - -node\_modules/axios/index.d.ts:321 - -##### transitional? - -```ts -optional transitional: TransitionalOptions; -``` - -###### Inherited from - -`Omit.transitional` - -###### Defined in - -node\_modules/axios/index.d.ts:350 - -##### transport? - -```ts -optional transport: any; -``` - -###### Inherited from - -`Omit.transport` - -###### Defined in - -node\_modules/axios/index.d.ts:344 - -##### url? - -```ts -optional url: string; -``` - -###### Inherited from - -`Omit.url` - -###### Defined in - -node\_modules/axios/index.d.ts:317 - -##### validateStatus? - -```ts -optional validateStatus: null | (status: number) => boolean; -``` - -###### Inherited from - -`Omit.validateStatus` - -###### Defined in - -node\_modules/axios/index.d.ts:338 - -##### withCredentials? - -```ts -optional withCredentials: boolean; -``` - -###### Inherited from - -`Omit.withCredentials` - -###### Defined in - -node\_modules/axios/index.d.ts:328 - -##### withXSRFToken? - -```ts -optional withXSRFToken: boolean | (config: InternalAxiosRequestConfig) => undefined | boolean; -``` - -###### Inherited from - -`Omit.withXSRFToken` - -###### Defined in - -node\_modules/axios/index.d.ts:360 - -##### xsrfCookieName? - -```ts -optional xsrfCookieName: string; -``` - -###### Inherited from - -`Omit.xsrfCookieName` - -###### Defined in - -node\_modules/axios/index.d.ts:333 - -##### xsrfHeaderName? - -```ts -optional xsrfHeaderName: string; -``` - -###### Inherited from - -`Omit.xsrfHeaderName` - -###### Defined in - -node\_modules/axios/index.d.ts:334 - -*** - -### AxiosInstance() - -#### Extends - -- [`Axios`](axios.md#axios) - -#### Extended by - -- [`AxiosStatic`](axios.md#axiosstatic) - -```ts -interface AxiosInstance(config: AxiosRequestConfig): Promise -``` - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -#### Returns - -`Promise`\<`R`\> - -#### Defined in - -node\_modules/axios/index.d.ts:507 - -```ts -interface AxiosInstance(url: string, config?: AxiosRequestConfig): Promise -``` - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -#### Returns - -`Promise`\<`R`\> - -#### Defined in - -node\_modules/axios/index.d.ts:508 - -#### Properties - -##### defaults - -```ts -defaults: Omit, "headers"> & object; -``` - -###### Type declaration - -###### headers - -```ts -headers: HeadersDefaults & object; -``` - -###### Overrides - -[`Axios`](axios.md#axios).[`defaults`](axios.md#defaults) - -###### Defined in - -node\_modules/axios/index.d.ts:510 - -##### interceptors - -```ts -interceptors: object; -``` - -###### request - -```ts -request: AxiosInterceptorManager>; -``` - -###### response - -```ts -response: AxiosInterceptorManager>; -``` - -###### Inherited from - -[`Axios`](axios.md#axios).[`interceptors`](axios.md#interceptors) - -###### Defined in - -node\_modules/axios/index.d.ts:488 - -#### Methods - -##### delete() - -```ts -delete(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`delete`](axios.md#delete) - -###### Defined in - -node\_modules/axios/index.d.ts:495 - -##### get() - -```ts -get(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`get`](axios.md#get) - -###### Defined in - -node\_modules/axios/index.d.ts:494 - -##### getUri() - -```ts -getUri(config?: AxiosRequestConfig): string -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`any`\> | - -###### Returns - -`string` - -###### Inherited from - -[`Axios`](axios.md#axios).[`getUri`](axios.md#geturi) - -###### Defined in - -node\_modules/axios/index.d.ts:492 - -##### head() - -```ts -head(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`head`](axios.md#head) - -###### Defined in - -node\_modules/axios/index.d.ts:496 - -##### options() - -```ts -options(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`options`](axios.md#options) - -###### Defined in - -node\_modules/axios/index.d.ts:497 - -##### patch() - -```ts -patch( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`patch`](axios.md#patch) - -###### Defined in - -node\_modules/axios/index.d.ts:500 - -##### patchForm() - -```ts -patchForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`patchForm`](axios.md#patchform) - -###### Defined in - -node\_modules/axios/index.d.ts:503 - -##### post() - -```ts -post( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`post`](axios.md#post) - -###### Defined in - -node\_modules/axios/index.d.ts:498 - -##### postForm() - -```ts -postForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`postForm`](axios.md#postform) - -###### Defined in - -node\_modules/axios/index.d.ts:501 - -##### put() - -```ts -put( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`put`](axios.md#put) - -###### Defined in - -node\_modules/axios/index.d.ts:499 - -##### putForm() - -```ts -putForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`putForm`](axios.md#putform) - -###### Defined in - -node\_modules/axios/index.d.ts:502 - -##### request() - -```ts -request(config: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`Axios`](axios.md#axios).[`request`](axios.md#request-1) - -###### Defined in - -node\_modules/axios/index.d.ts:493 - -*** - -### AxiosInterceptorManager\ - -#### Type Parameters - -| Type Parameter | -| ------ | -| `V` | - -#### Methods - -##### clear() - -```ts -clear(): void -``` - -###### Returns - -`void` - -###### Defined in - -node\_modules/axios/index.d.ts:482 - -##### eject() - -```ts -eject(id: number): void -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `id` | `number` | - -###### Returns - -`void` - -###### Defined in - -node\_modules/axios/index.d.ts:481 - -##### use() - -```ts -use( - onFulfilled?: null | (value: V) => V | Promise, - onRejected?: null | (error: any) => any, - options?: AxiosInterceptorOptions): number -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `onFulfilled`? | `null` \| (`value`: `V`) => `V` \| `Promise`\<`V`\> | -| `onRejected`? | `null` \| (`error`: `any`) => `any` | -| `options`? | [`AxiosInterceptorOptions`](axios.md#axiosinterceptoroptions) | - -###### Returns - -`number` - -###### Defined in - -node\_modules/axios/index.d.ts:480 - -*** - -### AxiosInterceptorOptions - -#### Properties - -##### runWhen()? - -```ts -optional runWhen: (config: InternalAxiosRequestConfig) => boolean; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`any`\> | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:476 - -##### synchronous? - -```ts -optional synchronous: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:475 - -*** - -### AxiosProgressEvent - -#### Properties - -##### bytes - -```ts -bytes: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:292 - -##### download? - -```ts -optional download: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:296 - -##### estimated? - -```ts -optional estimated: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:294 - -##### event? - -```ts -optional event: any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:297 - -##### lengthComputable - -```ts -lengthComputable: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:298 - -##### loaded - -```ts -loaded: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:289 - -##### progress? - -```ts -optional progress: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:291 - -##### rate? - -```ts -optional rate: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:293 - -##### total? - -```ts -optional total: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:290 - -##### upload? - -```ts -optional upload: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:295 - -*** - -### AxiosProxyConfig - -#### Properties - -##### auth? - -```ts -optional auth: AxiosBasicCredentials; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:124 - -##### host - -```ts -host: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:122 - -##### port - -```ts -port: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:123 - -##### protocol? - -```ts -optional protocol: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:125 - -*** - -### AxiosRequestConfig\ - -#### Extended by - -- [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd) - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `D` | `any` | - -#### Properties - -##### adapter? - -```ts -optional adapter: AxiosAdapterConfig | AxiosAdapterConfig[]; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:329 - -##### auth? - -```ts -optional auth: AxiosBasicCredentials; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:330 - -##### baseURL? - -```ts -optional baseURL: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:319 - -##### beforeRedirect()? - -```ts -optional beforeRedirect: (options: Record, responseDetails: object) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `options` | `Record`\<`string`, `any`\> | -| `responseDetails` | `object` | -| `responseDetails.headers` | `Record`\<`string`, `string`\> | -| `responseDetails.statusCode` | [`HttpStatusCode`](axios.md#httpstatuscode) | - -###### Returns - -`void` - -###### Defined in - -node\_modules/axios/index.d.ts:342 - -##### cancelToken? - -```ts -optional cancelToken: CancelToken; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:348 - -##### data? - -```ts -optional data: D; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:325 - -##### decompress? - -```ts -optional decompress: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:349 - -##### env? - -```ts -optional env: object; -``` - -###### FormData()? - -```ts -optional FormData: (...args: any[]) => object; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`args` | `any`[] | - -###### Returns - -`object` - -###### Defined in - -node\_modules/axios/index.d.ts:353 - -##### family? - -```ts -optional family: AddressFamily; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:357 - -##### fetchOptions? - -```ts -optional fetchOptions: Record; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:361 - -##### formSerializer? - -```ts -optional formSerializer: FormSerializerOptions; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:356 - -##### headers? - -```ts -optional headers: AxiosHeaders | Partial & Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:322 - -##### httpAgent? - -```ts -optional httpAgent: any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:345 - -##### httpsAgent? - -```ts -optional httpsAgent: any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:346 - -##### insecureHTTPParser? - -```ts -optional insecureHTTPParser: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:352 - -##### lookup? - -```ts -optional lookup: (hostname: string, options: object, cb: (err: null | Error, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void | (hostname: string, options: object) => Promise; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:358 - -##### maxBodyLength? - -```ts -optional maxBodyLength: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:339 - -##### maxContentLength? - -```ts -optional maxContentLength: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:337 - -##### maxRate? - -```ts -optional maxRate: number | [number, number]; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:341 - -##### maxRedirects? - -```ts -optional maxRedirects: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:340 - -##### method? - -```ts -optional method: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:318 - -##### onDownloadProgress()? - -```ts -optional onDownloadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Defined in - -node\_modules/axios/index.d.ts:336 - -##### onUploadProgress()? - -```ts -optional onUploadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Defined in - -node\_modules/axios/index.d.ts:335 - -##### params? - -```ts -optional params: any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:323 - -##### paramsSerializer? - -```ts -optional paramsSerializer: CustomParamsSerializer | ParamsSerializerOptions; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:324 - -##### proxy? - -```ts -optional proxy: false | AxiosProxyConfig; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:347 - -##### responseEncoding? - -```ts -optional responseEncoding: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:332 - -##### responseType? - -```ts -optional responseType: ResponseType; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:331 - -##### signal? - -```ts -optional signal: GenericAbortSignal; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:351 - -##### socketPath? - -```ts -optional socketPath: null | string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:343 - -##### timeout? - -```ts -optional timeout: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:326 - -##### timeoutErrorMessage? - -```ts -optional timeoutErrorMessage: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:327 - -##### transformRequest? - -```ts -optional transformRequest: AxiosRequestTransformer | AxiosRequestTransformer[]; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:320 - -##### transformResponse? - -```ts -optional transformResponse: AxiosResponseTransformer | AxiosResponseTransformer[]; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:321 - -##### transitional? - -```ts -optional transitional: TransitionalOptions; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:350 - -##### transport? - -```ts -optional transport: any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:344 - -##### url? - -```ts -optional url: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:317 - -##### validateStatus? - -```ts -optional validateStatus: null | (status: number) => boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:338 - -##### withCredentials? - -```ts -optional withCredentials: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:328 - -##### withXSRFToken? - -```ts -optional withXSRFToken: boolean | (config: InternalAxiosRequestConfig) => undefined | boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:360 - -##### xsrfCookieName? - -```ts -optional xsrfCookieName: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:333 - -##### xsrfHeaderName? - -```ts -optional xsrfHeaderName: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:334 - -*** - -### AxiosRequestTransformer() - -```ts -interface AxiosRequestTransformer( - this: InternalAxiosRequestConfig, - data: any, - headers: AxiosRequestHeaders): any -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `this` | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`any`\> | -| `data` | `any` | -| `headers` | [`AxiosRequestHeaders`](axios.md#axiosrequestheaders) | - -#### Returns - -`any` - -#### Defined in - -node\_modules/axios/index.d.ts:105 - -*** - -### AxiosResponse\ - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `D` | `any` | - -#### Properties - -##### config - -```ts -config: InternalAxiosRequestConfig; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:398 - -##### data - -```ts -data: T; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:394 - -##### headers - -```ts -headers: AxiosResponseHeaders | Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:397 - -##### request? - -```ts -optional request: any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:399 - -##### status - -```ts -status: number; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:395 - -##### statusText - -```ts -statusText: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:396 - -*** - -### AxiosResponseTransformer() - -```ts -interface AxiosResponseTransformer( - this: InternalAxiosRequestConfig, - data: any, - headers: AxiosResponseHeaders, - status?: number): any -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `this` | [`InternalAxiosRequestConfig`](axios.md#internalaxiosrequestconfigd)\<`any`\> | -| `data` | `any` | -| `headers` | [`AxiosResponseHeaders`](axios.md#axiosresponseheaders) | -| `status`? | `number` | - -#### Returns - -`any` - -#### Defined in - -node\_modules/axios/index.d.ts:109 - -*** - -### AxiosStatic() - -#### Extends - -- [`AxiosInstance`](axios.md#axiosinstance) - -```ts -interface AxiosStatic(config: AxiosRequestConfig): Promise -``` - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -#### Returns - -`Promise`\<`R`\> - -#### Defined in - -node\_modules/axios/index.d.ts:541 - -```ts -interface AxiosStatic(url: string, config?: AxiosRequestConfig): Promise -``` - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -#### Returns - -`Promise`\<`R`\> - -#### Defined in - -node\_modules/axios/index.d.ts:541 - -#### Properties - -##### Axios - -```ts -Axios: typeof Axios; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:545 - -##### AxiosError - -```ts -AxiosError: typeof AxiosError; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:546 - -##### AxiosHeaders - -```ts -AxiosHeaders: typeof AxiosHeaders; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:557 - -##### Cancel - -```ts -Cancel: CancelStatic; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:543 - -##### CancelToken - -```ts -CancelToken: CancelTokenStatic; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:544 - -##### CanceledError - -```ts -CanceledError: typeof CanceledError; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:556 - -##### HttpStatusCode - -```ts -HttpStatusCode: typeof HttpStatusCode; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:547 - -##### VERSION - -```ts -readonly VERSION: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:548 - -##### all() - -```ts -all: (values: (T | Promise)[]) => Promise; -``` - -###### Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `values` | (`T` \| `Promise`\<`T`\>)[] | - -###### Returns - -`Promise`\<`T`[]\> - -###### Defined in - -node\_modules/axios/index.d.ts:550 - -##### defaults - -```ts -defaults: Omit, "headers"> & object; -``` - -###### Type declaration - -###### headers - -```ts -headers: HeadersDefaults & object; -``` - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`defaults`](axios.md#defaults-1) - -###### Defined in - -node\_modules/axios/index.d.ts:510 - -##### formToJSON() - -```ts -formToJSON: (form: GenericFormData | GenericHTMLFormElement) => object; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `form` | [`GenericFormData`](axios.md#genericformdata) \| [`GenericHTMLFormElement`](axios.md#generichtmlformelement) | - -###### Returns - -`object` - -###### Defined in - -node\_modules/axios/index.d.ts:554 - -##### getAdapter() - -```ts -getAdapter: (adapters: undefined | AxiosAdapterConfig | AxiosAdapterConfig[]) => AxiosAdapter; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `adapters` | `undefined` \| `AxiosAdapterConfig` \| `AxiosAdapterConfig`[] | - -###### Returns - -[`AxiosAdapter`](axios.md#axiosadapter) - -###### Defined in - -node\_modules/axios/index.d.ts:555 - -##### interceptors - -```ts -interceptors: object; -``` - -###### request - -```ts -request: AxiosInterceptorManager>; -``` - -###### response - -```ts -response: AxiosInterceptorManager>; -``` - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`interceptors`](axios.md#interceptors-1) - -###### Defined in - -node\_modules/axios/index.d.ts:488 - -##### isAxiosError() - -```ts -isAxiosError: (payload: any) => payload is AxiosError; -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `payload` | `any` | - -###### Returns - -`payload is AxiosError` - -###### Defined in - -node\_modules/axios/index.d.ts:552 - -##### isCancel() - -```ts -isCancel: (value: any) => value is Cancel; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | `any` | - -###### Returns - -`value is Cancel` - -###### Defined in - -node\_modules/axios/index.d.ts:549 - -##### spread() - -```ts -spread: (callback: (...args: T[]) => R) => (array: T[]) => R; -``` - -###### Type Parameters - -| Type Parameter | -| ------ | -| `T` | -| `R` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `callback` | (...`args`: `T`[]) => `R` | - -###### Returns - -`Function` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `array` | `T`[] | - -###### Returns - -`R` - -###### Defined in - -node\_modules/axios/index.d.ts:551 - -##### toFormData() - -```ts -toFormData: (sourceObj: object, targetFormData?: GenericFormData, options?: FormSerializerOptions) => GenericFormData; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `sourceObj` | `object` | -| `targetFormData`? | [`GenericFormData`](axios.md#genericformdata) | -| `options`? | [`FormSerializerOptions`](axios.md#formserializeroptions) | - -###### Returns - -[`GenericFormData`](axios.md#genericformdata) - -###### Defined in - -node\_modules/axios/index.d.ts:553 - -#### Methods - -##### create() - -```ts -create(config?: CreateAxiosDefaults): AxiosInstance -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config`? | [`CreateAxiosDefaults`](axios.md#createaxiosdefaultsd)\<`any`\> | - -###### Returns - -[`AxiosInstance`](axios.md#axiosinstance) - -###### Defined in - -node\_modules/axios/index.d.ts:542 - -##### delete() - -```ts -delete(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`delete`](axios.md#delete-2) - -###### Defined in - -node\_modules/axios/index.d.ts:495 - -##### get() - -```ts -get(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`get`](axios.md#get-2) - -###### Defined in - -node\_modules/axios/index.d.ts:494 - -##### getUri() - -```ts -getUri(config?: AxiosRequestConfig): string -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`any`\> | - -###### Returns - -`string` - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`getUri`](axios.md#geturi-1) - -###### Defined in - -node\_modules/axios/index.d.ts:492 - -##### head() - -```ts -head(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`head`](axios.md#head-1) - -###### Defined in - -node\_modules/axios/index.d.ts:496 - -##### options() - -```ts -options(url: string, config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`options`](axios.md#options-1) - -###### Defined in - -node\_modules/axios/index.d.ts:497 - -##### patch() - -```ts -patch( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`patch`](axios.md#patch-1) - -###### Defined in - -node\_modules/axios/index.d.ts:500 - -##### patchForm() - -```ts -patchForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`patchForm`](axios.md#patchform-1) - -###### Defined in - -node\_modules/axios/index.d.ts:503 - -##### post() - -```ts -post( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`post`](axios.md#post-1) - -###### Defined in - -node\_modules/axios/index.d.ts:498 - -##### postForm() - -```ts -postForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`postForm`](axios.md#postform-1) - -###### Defined in - -node\_modules/axios/index.d.ts:501 - -##### put() - -```ts -put( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`put`](axios.md#put-1) - -###### Defined in - -node\_modules/axios/index.d.ts:499 - -##### putForm() - -```ts -putForm( - url: string, - data?: D, -config?: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `url` | `string` | -| `data`? | `D` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`putForm`](axios.md#putform-1) - -###### Defined in - -node\_modules/axios/index.d.ts:502 - -##### request() - -```ts -request(config: AxiosRequestConfig): Promise -``` - -###### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](axios.md#axiosresponsetd)\<`T`, `any`\> | -| `D` | `any` | - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> | - -###### Returns - -`Promise`\<`R`\> - -###### Inherited from - -[`AxiosInstance`](axios.md#axiosinstance).[`request`](axios.md#request-5) - -###### Defined in - -node\_modules/axios/index.d.ts:493 - -*** - -### Cancel - -#### Properties - -##### message - -```ts -message: undefined | string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:451 - -*** - -### CancelStatic - -#### Constructors - -##### new CancelStatic() - -```ts -new CancelStatic(message?: string): Cancel -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `message`? | `string` | - -###### Returns - -[`Cancel`](axios.md#cancel-1) - -###### Defined in - -node\_modules/axios/index.d.ts:447 - -*** - -### CancelToken - -#### Properties - -##### promise - -```ts -promise: Promise; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:464 - -##### reason? - -```ts -optional reason: Cancel; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:465 - -#### Methods - -##### throwIfRequested() - -```ts -throwIfRequested(): void -``` - -###### Returns - -`void` - -###### Defined in - -node\_modules/axios/index.d.ts:466 - -*** - -### CancelTokenSource - -#### Properties - -##### cancel - -```ts -cancel: Canceler; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:471 - -##### token - -```ts -token: CancelToken; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:470 - -*** - -### CancelTokenStatic - -#### Constructors - -##### new CancelTokenStatic() - -```ts -new CancelTokenStatic(executor: (cancel: Canceler) => void): CancelToken -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `executor` | (`cancel`: [`Canceler`](axios.md#canceler)) => `void` | - -###### Returns - -[`CancelToken`](axios.md#canceltoken-3) - -###### Defined in - -node\_modules/axios/index.d.ts:459 - -#### Methods - -##### source() - -```ts -source(): CancelTokenSource -``` - -###### Returns - -[`CancelTokenSource`](axios.md#canceltokensource) - -###### Defined in - -node\_modules/axios/index.d.ts:460 - -*** - -### Canceler() - -```ts -interface Canceler( - message?: string, - config?: AxiosRequestConfig, - request?: any): void -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `message`? | `string` | -| `config`? | [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`any`\> | -| `request`? | `any` | - -#### Returns - -`void` - -#### Defined in - -node\_modules/axios/index.d.ts:455 - -*** - -### CreateAxiosDefaults\ - -#### Extends - -- `Omit`\<[`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\>, `"headers"`\> - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `D` | `any` | - -#### Properties - -##### adapter? - -```ts -optional adapter: AxiosAdapterConfig | AxiosAdapterConfig[]; -``` - -###### Inherited from - -`Omit.adapter` - -###### Defined in - -node\_modules/axios/index.d.ts:329 - -##### auth? - -```ts -optional auth: AxiosBasicCredentials; -``` - -###### Inherited from - -`Omit.auth` - -###### Defined in - -node\_modules/axios/index.d.ts:330 - -##### baseURL? - -```ts -optional baseURL: string; -``` - -###### Inherited from - -`Omit.baseURL` - -###### Defined in - -node\_modules/axios/index.d.ts:319 - -##### beforeRedirect()? - -```ts -optional beforeRedirect: (options: Record, responseDetails: object) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `options` | `Record`\<`string`, `any`\> | -| `responseDetails` | `object` | -| `responseDetails.headers` | `Record`\<`string`, `string`\> | -| `responseDetails.statusCode` | [`HttpStatusCode`](axios.md#httpstatuscode) | - -###### Returns - -`void` - -###### Inherited from - -`Omit.beforeRedirect` - -###### Defined in - -node\_modules/axios/index.d.ts:342 - -##### cancelToken? - -```ts -optional cancelToken: CancelToken; -``` - -###### Inherited from - -`Omit.cancelToken` - -###### Defined in - -node\_modules/axios/index.d.ts:348 - -##### data? - -```ts -optional data: D; -``` - -###### Inherited from - -`Omit.data` - -###### Defined in - -node\_modules/axios/index.d.ts:325 - -##### decompress? - -```ts -optional decompress: boolean; -``` - -###### Inherited from - -`Omit.decompress` - -###### Defined in - -node\_modules/axios/index.d.ts:349 - -##### env? - -```ts -optional env: object; -``` - -###### FormData()? - -```ts -optional FormData: (...args: any[]) => object; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`args` | `any`[] | - -###### Returns - -`object` - -###### Inherited from - -`Omit.env` - -###### Defined in - -node\_modules/axios/index.d.ts:353 - -##### family? - -```ts -optional family: AddressFamily; -``` - -###### Inherited from - -`Omit.family` - -###### Defined in - -node\_modules/axios/index.d.ts:357 - -##### fetchOptions? - -```ts -optional fetchOptions: Record; -``` - -###### Inherited from - -`Omit.fetchOptions` - -###### Defined in - -node\_modules/axios/index.d.ts:361 - -##### formSerializer? - -```ts -optional formSerializer: FormSerializerOptions; -``` - -###### Inherited from - -`Omit.formSerializer` - -###### Defined in - -node\_modules/axios/index.d.ts:356 - -##### headers? - -```ts -optional headers: AxiosHeaders | Partial | Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:390 - -##### httpAgent? - -```ts -optional httpAgent: any; -``` - -###### Inherited from - -`Omit.httpAgent` - -###### Defined in - -node\_modules/axios/index.d.ts:345 - -##### httpsAgent? - -```ts -optional httpsAgent: any; -``` - -###### Inherited from - -`Omit.httpsAgent` - -###### Defined in - -node\_modules/axios/index.d.ts:346 - -##### insecureHTTPParser? - -```ts -optional insecureHTTPParser: boolean; -``` - -###### Inherited from - -`Omit.insecureHTTPParser` - -###### Defined in - -node\_modules/axios/index.d.ts:352 - -##### lookup? - -```ts -optional lookup: (hostname: string, options: object, cb: (err: null | Error, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void | (hostname: string, options: object) => Promise; -``` - -###### Inherited from - -`Omit.lookup` - -###### Defined in - -node\_modules/axios/index.d.ts:358 - -##### maxBodyLength? - -```ts -optional maxBodyLength: number; -``` - -###### Inherited from - -`Omit.maxBodyLength` - -###### Defined in - -node\_modules/axios/index.d.ts:339 - -##### maxContentLength? - -```ts -optional maxContentLength: number; -``` - -###### Inherited from - -`Omit.maxContentLength` - -###### Defined in - -node\_modules/axios/index.d.ts:337 - -##### maxRate? - -```ts -optional maxRate: number | [number, number]; -``` - -###### Inherited from - -`Omit.maxRate` - -###### Defined in - -node\_modules/axios/index.d.ts:341 - -##### maxRedirects? - -```ts -optional maxRedirects: number; -``` - -###### Inherited from - -`Omit.maxRedirects` - -###### Defined in - -node\_modules/axios/index.d.ts:340 - -##### method? - -```ts -optional method: string; -``` - -###### Inherited from - -`Omit.method` - -###### Defined in - -node\_modules/axios/index.d.ts:318 - -##### onDownloadProgress()? - -```ts -optional onDownloadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Inherited from - -`Omit.onDownloadProgress` - -###### Defined in - -node\_modules/axios/index.d.ts:336 - -##### onUploadProgress()? - -```ts -optional onUploadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Inherited from - -`Omit.onUploadProgress` - -###### Defined in - -node\_modules/axios/index.d.ts:335 - -##### params? - -```ts -optional params: any; -``` - -###### Inherited from - -`Omit.params` - -###### Defined in - -node\_modules/axios/index.d.ts:323 - -##### paramsSerializer? - -```ts -optional paramsSerializer: CustomParamsSerializer | ParamsSerializerOptions; -``` - -###### Inherited from - -`Omit.paramsSerializer` - -###### Defined in - -node\_modules/axios/index.d.ts:324 - -##### proxy? - -```ts -optional proxy: false | AxiosProxyConfig; -``` - -###### Inherited from - -`Omit.proxy` - -###### Defined in - -node\_modules/axios/index.d.ts:347 - -##### responseEncoding? - -```ts -optional responseEncoding: string; -``` - -###### Inherited from - -`Omit.responseEncoding` - -###### Defined in - -node\_modules/axios/index.d.ts:332 - -##### responseType? - -```ts -optional responseType: ResponseType; -``` - -###### Inherited from - -`Omit.responseType` - -###### Defined in - -node\_modules/axios/index.d.ts:331 - -##### signal? - -```ts -optional signal: GenericAbortSignal; -``` - -###### Inherited from - -`Omit.signal` - -###### Defined in - -node\_modules/axios/index.d.ts:351 - -##### socketPath? - -```ts -optional socketPath: null | string; -``` - -###### Inherited from - -`Omit.socketPath` - -###### Defined in - -node\_modules/axios/index.d.ts:343 - -##### timeout? - -```ts -optional timeout: number; -``` - -###### Inherited from - -`Omit.timeout` - -###### Defined in - -node\_modules/axios/index.d.ts:326 - -##### timeoutErrorMessage? - -```ts -optional timeoutErrorMessage: string; -``` - -###### Inherited from - -`Omit.timeoutErrorMessage` - -###### Defined in - -node\_modules/axios/index.d.ts:327 - -##### transformRequest? - -```ts -optional transformRequest: AxiosRequestTransformer | AxiosRequestTransformer[]; -``` - -###### Inherited from - -`Omit.transformRequest` - -###### Defined in - -node\_modules/axios/index.d.ts:320 - -##### transformResponse? - -```ts -optional transformResponse: AxiosResponseTransformer | AxiosResponseTransformer[]; -``` - -###### Inherited from - -`Omit.transformResponse` - -###### Defined in - -node\_modules/axios/index.d.ts:321 - -##### transitional? - -```ts -optional transitional: TransitionalOptions; -``` - -###### Inherited from - -`Omit.transitional` - -###### Defined in - -node\_modules/axios/index.d.ts:350 - -##### transport? - -```ts -optional transport: any; -``` - -###### Inherited from - -`Omit.transport` - -###### Defined in - -node\_modules/axios/index.d.ts:344 - -##### url? - -```ts -optional url: string; -``` - -###### Inherited from - -`Omit.url` - -###### Defined in - -node\_modules/axios/index.d.ts:317 - -##### validateStatus? - -```ts -optional validateStatus: null | (status: number) => boolean; -``` - -###### Inherited from - -`Omit.validateStatus` - -###### Defined in - -node\_modules/axios/index.d.ts:338 - -##### withCredentials? - -```ts -optional withCredentials: boolean; -``` - -###### Inherited from - -`Omit.withCredentials` - -###### Defined in - -node\_modules/axios/index.d.ts:328 - -##### withXSRFToken? - -```ts -optional withXSRFToken: boolean | (config: InternalAxiosRequestConfig) => undefined | boolean; -``` - -###### Inherited from - -`Omit.withXSRFToken` - -###### Defined in - -node\_modules/axios/index.d.ts:360 - -##### xsrfCookieName? - -```ts -optional xsrfCookieName: string; -``` - -###### Inherited from - -`Omit.xsrfCookieName` - -###### Defined in - -node\_modules/axios/index.d.ts:333 - -##### xsrfHeaderName? - -```ts -optional xsrfHeaderName: string; -``` - -###### Inherited from - -`Omit.xsrfHeaderName` - -###### Defined in - -node\_modules/axios/index.d.ts:334 - -*** - -### CustomParamsSerializer() - -```ts -interface CustomParamsSerializer(params: Record, options?: ParamsSerializerOptions): string -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `params` | `Record`\<`string`, `any`\> | -| `options`? | [`ParamsSerializerOptions`](axios.md#paramsserializeroptions) | - -#### Returns - -`string` - -#### Defined in - -node\_modules/axios/index.d.ts:274 - -*** - -### FormDataVisitorHelpers - -#### Properties - -##### convertValue() - -```ts -convertValue: (value: any) => any; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | `any` | - -###### Returns - -`any` - -###### Defined in - -node\_modules/axios/index.d.ts:244 - -##### defaultVisitor - -```ts -defaultVisitor: SerializerVisitor; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:243 - -##### isVisitable() - -```ts -isVisitable: (value: any) => boolean; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | `any` | - -###### Returns - -`boolean` - -###### Defined in - -node\_modules/axios/index.d.ts:245 - -*** - -### FormSerializerOptions - -#### Extends - -- [`SerializerOptions`](axios.md#serializeroptions) - -#### Properties - -##### dots? - -```ts -optional dots: boolean; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`dots`](axios.md#dots-2) - -###### Defined in - -node\_modules/axios/index.d.ts:260 - -##### indexes? - -```ts -optional indexes: null | boolean; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`indexes`](axios.md#indexes-2) - -###### Defined in - -node\_modules/axios/index.d.ts:262 - -##### metaTokens? - -```ts -optional metaTokens: boolean; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`metaTokens`](axios.md#metatokens-2) - -###### Defined in - -node\_modules/axios/index.d.ts:261 - -##### visitor? - -```ts -optional visitor: SerializerVisitor; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`visitor`](axios.md#visitor-2) - -###### Defined in - -node\_modules/axios/index.d.ts:259 - -*** - -### GenericAbortSignal - -#### Properties - -##### aborted - -```ts -readonly aborted: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:236 - -##### addEventListener()? - -```ts -optional addEventListener: (...args: any) => any; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`args` | `any` | - -###### Returns - -`any` - -###### Defined in - -node\_modules/axios/index.d.ts:238 - -##### onabort? - -```ts -optional onabort: null | (...args: any) => any; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:237 - -##### removeEventListener()? - -```ts -optional removeEventListener: (...args: any) => any; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`args` | `any` | - -###### Returns - -`any` - -###### Defined in - -node\_modules/axios/index.d.ts:239 - -*** - -### GenericFormData - -#### Methods - -##### append() - -```ts -append( - name: string, - value: any, - options?: any): any -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `name` | `string` | -| `value` | `any` | -| `options`? | `any` | - -###### Returns - -`any` - -###### Defined in - -node\_modules/axios/index.d.ts:518 - -*** - -### GenericHTMLFormElement - -#### Properties - -##### method - -```ts -method: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:523 - -##### name - -```ts -name: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:522 - -#### Methods - -##### submit() - -```ts -submit(): void -``` - -###### Returns - -`void` - -###### Defined in - -node\_modules/axios/index.d.ts:524 - -*** - -### HeadersDefaults - -#### Properties - -##### common - -```ts -common: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:372 - -##### delete - -```ts -delete: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:373 - -##### get - -```ts -get: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:374 - -##### head - -```ts -head: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:375 - -##### link? - -```ts -optional link: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:381 - -##### options? - -```ts -optional options: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:379 - -##### patch - -```ts -patch: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:378 - -##### post - -```ts -post: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:376 - -##### purge? - -```ts -optional purge: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:380 - -##### put - -```ts -put: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:377 - -##### unlink? - -```ts -optional unlink: Partial; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:382 - -*** - -### InternalAxiosRequestConfig\ - -#### Extends - -- [`AxiosRequestConfig`](axios.md#axiosrequestconfigd)\<`D`\> - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `D` | `any` | - -#### Properties - -##### adapter? - -```ts -optional adapter: AxiosAdapterConfig | AxiosAdapterConfig[]; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`adapter`](axios.md#adapter-1) - -###### Defined in - -node\_modules/axios/index.d.ts:329 - -##### auth? - -```ts -optional auth: AxiosBasicCredentials; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`auth`](axios.md#auth-2) - -###### Defined in - -node\_modules/axios/index.d.ts:330 - -##### baseURL? - -```ts -optional baseURL: string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`baseURL`](axios.md#baseurl-1) - -###### Defined in - -node\_modules/axios/index.d.ts:319 - -##### beforeRedirect()? - -```ts -optional beforeRedirect: (options: Record, responseDetails: object) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `options` | `Record`\<`string`, `any`\> | -| `responseDetails` | `object` | -| `responseDetails.headers` | `Record`\<`string`, `string`\> | -| `responseDetails.statusCode` | [`HttpStatusCode`](axios.md#httpstatuscode) | - -###### Returns - -`void` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`beforeRedirect`](axios.md#beforeredirect-1) - -###### Defined in - -node\_modules/axios/index.d.ts:342 - -##### cancelToken? - -```ts -optional cancelToken: CancelToken; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`cancelToken`](axios.md#canceltoken-1) - -###### Defined in - -node\_modules/axios/index.d.ts:348 - -##### data? - -```ts -optional data: D; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`data`](axios.md#data-1) - -###### Defined in - -node\_modules/axios/index.d.ts:325 - -##### decompress? - -```ts -optional decompress: boolean; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`decompress`](axios.md#decompress-1) - -###### Defined in - -node\_modules/axios/index.d.ts:349 - -##### env? - -```ts -optional env: object; -``` - -###### FormData()? - -```ts -optional FormData: (...args: any[]) => object; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| ...`args` | `any`[] | - -###### Returns - -`object` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`env`](axios.md#env-1) - -###### Defined in - -node\_modules/axios/index.d.ts:353 - -##### family? - -```ts -optional family: AddressFamily; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`family`](axios.md#family-1) - -###### Defined in - -node\_modules/axios/index.d.ts:357 - -##### fetchOptions? - -```ts -optional fetchOptions: Record; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`fetchOptions`](axios.md#fetchoptions-1) - -###### Defined in - -node\_modules/axios/index.d.ts:361 - -##### formSerializer? - -```ts -optional formSerializer: FormSerializerOptions; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`formSerializer`](axios.md#formserializer-1) - -###### Defined in - -node\_modules/axios/index.d.ts:356 - -##### headers - -```ts -headers: AxiosRequestHeaders; -``` - -###### Overrides - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`headers`](axios.md#headers-1) - -###### Defined in - -node\_modules/axios/index.d.ts:368 - -##### httpAgent? - -```ts -optional httpAgent: any; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`httpAgent`](axios.md#httpagent-1) - -###### Defined in - -node\_modules/axios/index.d.ts:345 - -##### httpsAgent? - -```ts -optional httpsAgent: any; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`httpsAgent`](axios.md#httpsagent-1) - -###### Defined in - -node\_modules/axios/index.d.ts:346 - -##### insecureHTTPParser? - -```ts -optional insecureHTTPParser: boolean; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`insecureHTTPParser`](axios.md#insecurehttpparser-1) - -###### Defined in - -node\_modules/axios/index.d.ts:352 - -##### lookup? - -```ts -optional lookup: (hostname: string, options: object, cb: (err: null | Error, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void | (hostname: string, options: object) => Promise; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`lookup`](axios.md#lookup-1) - -###### Defined in - -node\_modules/axios/index.d.ts:358 - -##### maxBodyLength? - -```ts -optional maxBodyLength: number; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`maxBodyLength`](axios.md#maxbodylength-1) - -###### Defined in - -node\_modules/axios/index.d.ts:339 - -##### maxContentLength? - -```ts -optional maxContentLength: number; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`maxContentLength`](axios.md#maxcontentlength-1) - -###### Defined in - -node\_modules/axios/index.d.ts:337 - -##### maxRate? - -```ts -optional maxRate: number | [number, number]; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`maxRate`](axios.md#maxrate-1) - -###### Defined in - -node\_modules/axios/index.d.ts:341 - -##### maxRedirects? - -```ts -optional maxRedirects: number; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`maxRedirects`](axios.md#maxredirects-1) - -###### Defined in - -node\_modules/axios/index.d.ts:340 - -##### method? - -```ts -optional method: string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`method`](axios.md#method-1) - -###### Defined in - -node\_modules/axios/index.d.ts:318 - -##### onDownloadProgress()? - -```ts -optional onDownloadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`onDownloadProgress`](axios.md#ondownloadprogress-1) - -###### Defined in - -node\_modules/axios/index.d.ts:336 - -##### onUploadProgress()? - -```ts -optional onUploadProgress: (progressEvent: AxiosProgressEvent) => void; -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `progressEvent` | [`AxiosProgressEvent`](axios.md#axiosprogressevent) | - -###### Returns - -`void` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`onUploadProgress`](axios.md#onuploadprogress-1) - -###### Defined in - -node\_modules/axios/index.d.ts:335 - -##### params? - -```ts -optional params: any; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`params`](axios.md#params-1) - -###### Defined in - -node\_modules/axios/index.d.ts:323 - -##### paramsSerializer? - -```ts -optional paramsSerializer: CustomParamsSerializer | ParamsSerializerOptions; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`paramsSerializer`](axios.md#paramsserializer-1) - -###### Defined in - -node\_modules/axios/index.d.ts:324 - -##### proxy? - -```ts -optional proxy: false | AxiosProxyConfig; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`proxy`](axios.md#proxy-1) - -###### Defined in - -node\_modules/axios/index.d.ts:347 - -##### responseEncoding? - -```ts -optional responseEncoding: string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`responseEncoding`](axios.md#responseencoding-1) - -###### Defined in - -node\_modules/axios/index.d.ts:332 - -##### responseType? - -```ts -optional responseType: ResponseType; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`responseType`](axios.md#responsetype-1) - -###### Defined in - -node\_modules/axios/index.d.ts:331 - -##### signal? - -```ts -optional signal: GenericAbortSignal; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`signal`](axios.md#signal-1) - -###### Defined in - -node\_modules/axios/index.d.ts:351 - -##### socketPath? - -```ts -optional socketPath: null | string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`socketPath`](axios.md#socketpath-1) - -###### Defined in - -node\_modules/axios/index.d.ts:343 - -##### timeout? - -```ts -optional timeout: number; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`timeout`](axios.md#timeout-1) - -###### Defined in - -node\_modules/axios/index.d.ts:326 - -##### timeoutErrorMessage? - -```ts -optional timeoutErrorMessage: string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`timeoutErrorMessage`](axios.md#timeouterrormessage-1) - -###### Defined in - -node\_modules/axios/index.d.ts:327 - -##### transformRequest? - -```ts -optional transformRequest: AxiosRequestTransformer | AxiosRequestTransformer[]; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`transformRequest`](axios.md#transformrequest-1) - -###### Defined in - -node\_modules/axios/index.d.ts:320 - -##### transformResponse? - -```ts -optional transformResponse: AxiosResponseTransformer | AxiosResponseTransformer[]; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`transformResponse`](axios.md#transformresponse-1) - -###### Defined in - -node\_modules/axios/index.d.ts:321 - -##### transitional? - -```ts -optional transitional: TransitionalOptions; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`transitional`](axios.md#transitional-1) - -###### Defined in - -node\_modules/axios/index.d.ts:350 - -##### transport? - -```ts -optional transport: any; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`transport`](axios.md#transport-1) - -###### Defined in - -node\_modules/axios/index.d.ts:344 - -##### url? - -```ts -optional url: string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`url`](axios.md#url-1) - -###### Defined in - -node\_modules/axios/index.d.ts:317 - -##### validateStatus? - -```ts -optional validateStatus: null | (status: number) => boolean; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`validateStatus`](axios.md#validatestatus-1) - -###### Defined in - -node\_modules/axios/index.d.ts:338 - -##### withCredentials? - -```ts -optional withCredentials: boolean; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`withCredentials`](axios.md#withcredentials-1) - -###### Defined in - -node\_modules/axios/index.d.ts:328 - -##### withXSRFToken? - -```ts -optional withXSRFToken: boolean | (config: InternalAxiosRequestConfig) => undefined | boolean; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`withXSRFToken`](axios.md#withxsrftoken-1) - -###### Defined in - -node\_modules/axios/index.d.ts:360 - -##### xsrfCookieName? - -```ts -optional xsrfCookieName: string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`xsrfCookieName`](axios.md#xsrfcookiename-1) - -###### Defined in - -node\_modules/axios/index.d.ts:333 - -##### xsrfHeaderName? - -```ts -optional xsrfHeaderName: string; -``` - -###### Inherited from - -[`AxiosRequestConfig`](axios.md#axiosrequestconfigd).[`xsrfHeaderName`](axios.md#xsrfheadername-1) - -###### Defined in - -node\_modules/axios/index.d.ts:334 - -*** - -### LookupAddressEntry - -#### Properties - -##### address - -```ts -address: string; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:310 - -##### family? - -```ts -optional family: AddressFamily; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:311 - -*** - -### ParamEncoder() - -```ts -interface ParamEncoder(value: any, defaultEncoder: (value: any) => any): any -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | `any` | -| `defaultEncoder` | (`value`: `any`) => `any` | - -#### Returns - -`any` - -#### Defined in - -node\_modules/axios/index.d.ts:270 - -*** - -### ParamsSerializerOptions - -#### Extends - -- [`SerializerOptions`](axios.md#serializeroptions) - -#### Properties - -##### dots? - -```ts -optional dots: boolean; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`dots`](axios.md#dots-2) - -###### Defined in - -node\_modules/axios/index.d.ts:260 - -##### encode? - -```ts -optional encode: ParamEncoder; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:278 - -##### indexes? - -```ts -optional indexes: null | boolean; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`indexes`](axios.md#indexes-2) - -###### Defined in - -node\_modules/axios/index.d.ts:262 - -##### metaTokens? - -```ts -optional metaTokens: boolean; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`metaTokens`](axios.md#metatokens-2) - -###### Defined in - -node\_modules/axios/index.d.ts:261 - -##### serialize? - -```ts -optional serialize: CustomParamsSerializer; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:279 - -##### visitor? - -```ts -optional visitor: SerializerVisitor; -``` - -###### Inherited from - -[`SerializerOptions`](axios.md#serializeroptions).[`visitor`](axios.md#visitor-2) - -###### Defined in - -node\_modules/axios/index.d.ts:259 - -*** - -### SerializerOptions - -#### Extended by - -- [`FormSerializerOptions`](axios.md#formserializeroptions) -- [`ParamsSerializerOptions`](axios.md#paramsserializeroptions) - -#### Properties - -##### dots? - -```ts -optional dots: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:260 - -##### indexes? - -```ts -optional indexes: null | boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:262 - -##### metaTokens? - -```ts -optional metaTokens: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:261 - -##### visitor? - -```ts -optional visitor: SerializerVisitor; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:259 - -*** - -### SerializerVisitor() - -```ts -interface SerializerVisitor( - this: GenericFormData, - value: any, - key: string | number, - path: null | (string | number)[], - helpers: FormDataVisitorHelpers): boolean -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `this` | [`GenericFormData`](axios.md#genericformdata) | -| `value` | `any` | -| `key` | `string` \| `number` | -| `path` | `null` \| (`string` \| `number`)[] | -| `helpers` | [`FormDataVisitorHelpers`](axios.md#formdatavisitorhelpers) | - -#### Returns - -`boolean` - -#### Defined in - -node\_modules/axios/index.d.ts:249 - -*** - -### TransitionalOptions - -#### Properties - -##### clarifyTimeoutError? - -```ts -optional clarifyTimeoutError: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:232 - -##### forcedJSONParsing? - -```ts -optional forcedJSONParsing: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:231 - -##### silentJSONParsing? - -```ts -optional silentJSONParsing: boolean; -``` - -###### Defined in - -node\_modules/axios/index.d.ts:230 - -## Type Aliases - -### AddressFamily - -```ts -type AddressFamily: 4 | 6 | undefined; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:307 - -*** - -### AxiosHeaderValue - -```ts -type AxiosHeaderValue: - | AxiosHeaders - | string - | string[] - | number - | boolean - | null; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:2 - -*** - -### AxiosPromise\ - -```ts -type AxiosPromise: Promise>; -``` - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | - -#### Defined in - -node\_modules/axios/index.d.ts:444 - -*** - -### AxiosRequestHeaders - -```ts -type AxiosRequestHeaders: RawAxiosRequestHeaders & AxiosHeaders; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:90 - -*** - -### AxiosResponseHeaders - -```ts -type AxiosResponseHeaders: RawAxiosResponseHeaders & AxiosHeaders; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:102 - -*** - -### LookupAddress - -```ts -type LookupAddress: string | LookupAddressEntry; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:314 - -*** - -### Method - -```ts -type Method: - | "get" - | "GET" - | "delete" - | "DELETE" - | "head" - | "HEAD" - | "options" - | "OPTIONS" - | "post" - | "POST" - | "put" - | "PUT" - | "patch" - | "PATCH" - | "purge" - | "PURGE" - | "link" - | "LINK" - | "unlink" - | "UNLINK"; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:194 - -*** - -### RawAxiosRequestConfig\ - -```ts -type RawAxiosRequestConfig: AxiosRequestConfig; -``` - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `D` | `any` | - -#### Defined in - -node\_modules/axios/index.d.ts:365 - -*** - -### RawAxiosRequestHeaders - -```ts -type RawAxiosRequestHeaders: Partial; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:84 - -*** - -### RawAxiosResponseHeaders - -```ts -type RawAxiosResponseHeaders: Partial; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:100 - -*** - -### ResponseType - -```ts -type ResponseType: - | "arraybuffer" - | "blob" - | "document" - | "json" - | "text" - | "stream" - | "formdata"; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:206 - -*** - -### responseEncoding - -```ts -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"; -``` - -#### Defined in - -node\_modules/axios/index.d.ts:215 - -## Functions - -### all() - -```ts -function all(values: (T | Promise)[]): Promise -``` - -#### Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `values` | (`T` \| `Promise`\<`T`\>)[] | - -#### Returns - -`Promise`\<`T`[]\> - -#### Defined in - -node\_modules/axios/index.d.ts:539 - -*** - -### formToJSON() - -```ts -function formToJSON(form: GenericFormData | GenericHTMLFormElement): object -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `form` | [`GenericFormData`](axios.md#genericformdata) \| [`GenericHTMLFormElement`](axios.md#generichtmlformelement) | - -#### Returns - -`object` - -#### Defined in - -node\_modules/axios/index.d.ts:531 - -*** - -### getAdapter() - -```ts -function getAdapter(adapters: undefined | AxiosAdapterConfig | AxiosAdapterConfig[]): AxiosAdapter -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `adapters` | `undefined` \| `AxiosAdapterConfig` \| `AxiosAdapterConfig`[] | - -#### Returns - -[`AxiosAdapter`](axios.md#axiosadapter) - -#### Defined in - -node\_modules/axios/index.d.ts:527 - -*** - -### isAxiosError() - -```ts -function isAxiosError(payload: any): payload is AxiosError -``` - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `T` | `any` | -| `D` | `any` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `payload` | `any` | - -#### Returns - -`payload is AxiosError` - -#### Defined in - -node\_modules/axios/index.d.ts:533 - -*** - -### isCancel() - -```ts -function isCancel(value: any): value is Cancel -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | `any` | - -#### Returns - -`value is Cancel` - -#### Defined in - -node\_modules/axios/index.d.ts:537 - -*** - -### spread() - -```ts -function spread(callback: (...args: T[]) => R): (array: T[]) => R -``` - -#### Type Parameters - -| Type Parameter | -| ------ | -| `T` | -| `R` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `callback` | (...`args`: `T`[]) => `R` | - -#### Returns - -`Function` - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `array` | `T`[] | - -##### Returns - -`R` - -#### Defined in - -node\_modules/axios/index.d.ts:535 - -*** - -### toFormData() - -```ts -function toFormData( - sourceObj: object, - targetFormData?: GenericFormData, - options?: FormSerializerOptions): GenericFormData -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `sourceObj` | `object` | -| `targetFormData`? | [`GenericFormData`](axios.md#genericformdata) | -| `options`? | [`FormSerializerOptions`](axios.md#formserializeroptions) | - -#### Returns - -[`GenericFormData`](axios.md#genericformdata) - -#### Defined in - -node\_modules/axios/index.d.ts:529 diff --git a/docs/nodejs/docs/clip_manager.md b/docs/nodejs/docs/clip_manager.md deleted file mode 100644 index f9715dd..0000000 --- a/docs/nodejs/docs/clip_manager.md +++ /dev/null @@ -1,83 +0,0 @@ -# clip\_manager - -## Variables - -### clipboardManager - -```ts -const clipboardManager: EventEmitter; -``` - -#### Defined in - -[src/clip\_manager/index.ts:5](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/clip_manager/index.ts#L5) - -## Functions - -### clearClip() - -```ts -function clearClip(): void -``` - -#### Returns - -`void` - -#### Defined in - -[src/clip\_manager/index.ts:23](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/clip_manager/index.ts#L23) - -*** - -### getClip() - -```ts -function getClip(): string -``` - -#### Returns - -`string` - -#### Defined in - -[src/clip\_manager/index.ts:15](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/clip_manager/index.ts#L15) - -*** - -### hasClip() - -```ts -function hasClip(): boolean -``` - -#### Returns - -`boolean` - -#### Defined in - -[src/clip\_manager/index.ts:19](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/clip_manager/index.ts#L19) - -*** - -### setClip() - -```ts -function setClip(text: string): void -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `text` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/clip\_manager/index.ts:11](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/clip_manager/index.ts#L11) diff --git a/docs/nodejs/docs/java.md b/docs/nodejs/docs/java.md deleted file mode 100644 index 1e06777..0000000 --- a/docs/nodejs/docs/java.md +++ /dev/null @@ -1,140 +0,0 @@ -# java - -## Functions - -### invokeDefault() - -```ts -function invokeDefault( - javaobj: any, - methodName: string, -args?: any[]): Promise -``` - -**`Alpha`** - -采用默认的计算线程池异步调用java方法，返回Promise接受结果 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `javaobj` | `any` | java对象，不能是js对象 | -| `methodName` | `string` | 要调用的方法名 | -| `args`? | `any`[] | 传递的参数 | - -#### Returns - -`Promise`\<`T`\> - -调用结果 - -#### Defined in - -[src/java/index.ts:11](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/java/index.ts#L11) - -*** - -### invokeIo() - -```ts -function invokeIo( - javaobj: any, - methodName: string, -args?: any[]): Promise -``` - -**`Alpha`** - -和[invokeDefault](java.md#invokedefault)类似，采用io线程池 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `javaobj` | `any` | | -| `methodName` | `string` | | -| `args`? | `any`[] | | - -#### Returns - -`Promise`\<`T`\> - -#### Defined in - -[src/java/index.ts:33](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/java/index.ts#L33) - -*** - -### invokeUi() - -```ts -function invokeUi( - javaobj: any, - methodName: string, -args?: any[]): Promise -``` - -**`Alpha`** - -和[invokeDefault](java.md#invokedefault)类似，采用ui线程 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `javaobj` | `any` | | -| `methodName` | `string` | | -| `args`? | `any`[] | | - -#### Returns - -`Promise`\<`T`\> - -#### Defined in - -[src/java/index.ts:47](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/java/index.ts#L47) - -*** - -### loadClass() - -```ts -function loadClass(className: string): JavaClass -``` - -**`Alpha`** - -加载并返回一个java类 - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `className` | `string` | java全类名 | - -#### Returns - -`JavaClass` - -#### Defined in - -[src/java/index.ts:22](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/java/index.ts#L22) diff --git a/docs/nodejs/docs/media.md b/docs/nodejs/docs/media.md deleted file mode 100644 index 3f7b46e..0000000 --- a/docs/nodejs/docs/media.md +++ /dev/null @@ -1,354 +0,0 @@ -# media - -## Classes - -### MediaPlayer - -#### Constructors - -##### new MediaPlayer() - -```ts -new MediaPlayer(): MediaPlayer -``` - -###### Returns - -[`MediaPlayer`](media.md#mediaplayer) - -#### Accessors - -##### androidMediaPlayer - -```ts -get androidMediaPlayer(): any -``` - -###### Returns - -`any` - -###### Defined in - -[src/media/index.ts:5](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L5) - -##### currentPosition - -```ts -get currentPosition(): number -``` - -###### Returns - -`number` - -当前播放位置。单位毫秒。 - -###### Defined in - -[src/media/index.ts:11](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L11) - -##### duration - -```ts -get duration(): number -``` - -###### Returns - -`number` - -音乐时长。单位毫秒。 - -###### Defined in - -[src/media/index.ts:17](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L17) - -##### isPlaying - -```ts -get isPlaying(): boolean -``` - -###### Returns - -`boolean` - -###### Defined in - -[src/media/index.ts:20](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L20) - -#### Methods - -##### pause() - -```ts -pause(): void -``` - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:30](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L30) - -##### play() - -```ts -play( - uri: string, - volume?: number, -looping?: boolean): Promise -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `uri` | `string` | -| `volume`? | `number` | -| `looping`? | `boolean` | - -###### Returns - -`Promise`\<`void`\> - -###### Defined in - -[src/media/index.ts:23](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L23) - -##### prepare() - -```ts -prepare(): Promise -``` - -###### Returns - -`Promise`\<`void`\> - -###### Defined in - -[src/media/index.ts:33](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L33) - -##### prepareSync() - -```ts -prepareSync(): void -``` - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:36](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L36) - -##### release() - -```ts -release(): void -``` - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:39](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L39) - -##### reset() - -```ts -reset(): void -``` - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:42](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L42) - -##### seekTo() - -```ts -seekTo(msec: number): Promise -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `msec` | `number` | - -###### Returns - -`Promise`\<`void`\> - -###### Defined in - -[src/media/index.ts:45](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L45) - -##### setDataSource() - -```ts -setDataSource(path: string): void -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `path` | `string` | - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:48](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L48) - -##### setLooping() - -```ts -setLooping(looping: boolean): void -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `looping` | `boolean` | - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:51](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L51) - -##### setScreenOnWhilePlaying() - -```ts -setScreenOnWhilePlaying(keep: boolean): void -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `keep` | `boolean` | - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:54](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L54) - -##### setVolume() - -```ts -setVolume(leftVolume: number, rightVolume?: number): void -``` - -###### Parameters - -| Parameter | Type | -| ------ | ------ | -| `leftVolume` | `number` | -| `rightVolume`? | `number` | - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:57](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L57) - -##### start() - -```ts -start(): void -``` - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:61](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L61) - -##### stop() - -```ts -stop(): void -``` - -###### Returns - -`void` - -###### Defined in - -[src/media/index.ts:64](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L64) - -## Functions - -### playMusic() - -```ts -function playMusic( - uri: string, - volume?: number, -looping?: boolean): Promise -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `uri` | `string` | -| `volume`? | `number` | -| `looping`? | `boolean` | - -#### Returns - -`Promise`\<[`MediaPlayer`](media.md#mediaplayer)\> - -#### Defined in - -[src/media/index.ts:69](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L69) - -*** - -### scanFile() - -```ts -function scanFile(file: string): void -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `file` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/media/index.ts:75](https://github.com/aiselp/AutoX/blob/fef14132f01d123d8ccfc0937f3f37dc42567abf/autojs/src/js-api/src/media/index.ts#L75) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 3a711b1..086d253 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -100,7 +100,7 @@ const config: Config = { to: '/docs/rhino/documentation', }, { label: 'nodejs api文档(v7)', - to: '/docs/rhino/documentation', + to: '/docs/nodejs/intro', }, ], }, diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 9542792..74c32f2 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -34,6 +34,11 @@ function HomepageHeader() { to="/docs/rhino/documentation"> 进入第一代api文档 + + 进入第二代api文档 +