3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
133 lines
3.2 KiB
Markdown
133 lines
3.2 KiB
Markdown
---
|
|
displayed_sidebar: jsClientSidebar
|
|
---
|
|
|
|
# Interface: AxiosPromise<T\>
|
|
|
|
[internal](../modules/internal.md).AxiosPromise
|
|
|
|
## Type parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `T` | `any` |
|
|
|
|
## Hierarchy
|
|
|
|
- [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`\>\>
|
|
|
|
↳ **`AxiosPromise`**
|
|
|
|
## Properties
|
|
|
|
### [toStringTag]
|
|
|
|
• `Readonly` **[toStringTag]**: `string`
|
|
|
|
#### Inherited from
|
|
|
|
Promise.\_\_@toStringTag@311
|
|
|
|
#### Defined in
|
|
|
|
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174
|
|
|
|
## Methods
|
|
|
|
### catch
|
|
|
|
▸ **catch**<`TResult`\>(`onrejected?`): [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> \| `TResult`\>
|
|
|
|
Attaches a callback for only the rejection of the Promise.
|
|
|
|
#### Type parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `TResult` | `never` |
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. |
|
|
|
|
#### Returns
|
|
|
|
[`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> \| `TResult`\>
|
|
|
|
A Promise for the completion of the callback.
|
|
|
|
#### Inherited from
|
|
|
|
Promise.catch
|
|
|
|
#### Defined in
|
|
|
|
node_modules/typescript/lib/lib.es5.d.ts:1509
|
|
|
|
___
|
|
|
|
### finally
|
|
|
|
▸ **finally**(`onfinally?`): [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>\>
|
|
|
|
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
|
|
resolved value cannot be modified from the callback.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). |
|
|
|
|
#### Returns
|
|
|
|
[`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>\>
|
|
|
|
A Promise for the completion of the callback.
|
|
|
|
#### Inherited from
|
|
|
|
Promise.finally
|
|
|
|
#### Defined in
|
|
|
|
node_modules/typescript/lib/lib.es2018.promise.d.ts:31
|
|
|
|
___
|
|
|
|
### then
|
|
|
|
▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\>
|
|
|
|
Attaches callbacks for the resolution and/or rejection of the Promise.
|
|
|
|
#### Type parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `TResult1` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
|
| `TResult2` | `never` |
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `onfulfilled?` | ``null`` \| (`value`: [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>) => `TResult1` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. |
|
|
| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. |
|
|
|
|
#### Returns
|
|
|
|
[`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\>
|
|
|
|
A Promise for the completion of which ever callback is executed.
|
|
|
|
#### Inherited from
|
|
|
|
Promise.then
|
|
|
|
#### Defined in
|
|
|
|
node_modules/typescript/lib/lib.es5.d.ts:1502
|