docs: added reference for JS Client (#1629)
* added reference for JS Client * added reference for JS Client * added reference for JS Client
This commit is contained in:
Shahed Nasser
GitHub
@@ -0,0 +1,21 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AbortSignal
|
||||
|
||||
[internal](../modules/internal.md).AbortSignal
|
||||
|
||||
A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.
|
||||
|
||||
## Properties
|
||||
|
||||
### aborted
|
||||
|
||||
• `Readonly` **aborted**: `boolean`
|
||||
|
||||
Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:64
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosAdapter
|
||||
|
||||
[internal](../modules/internal.md).AxiosAdapter
|
||||
|
||||
## Callable
|
||||
|
||||
### AxiosAdapter
|
||||
|
||||
▸ **AxiosAdapter**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:18
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosBasicCredentials
|
||||
|
||||
[internal](../modules/internal.md).AxiosBasicCredentials
|
||||
|
||||
## Properties
|
||||
|
||||
### password
|
||||
|
||||
• **password**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:23
|
||||
|
||||
___
|
||||
|
||||
### username
|
||||
|
||||
• **username**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:22
|
||||
@@ -0,0 +1,507 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosDefaults<D\>
|
||||
|
||||
[internal](../modules/internal.md).AxiosDefaults
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `D` | `any` |
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`Omit`](../modules/internal.md#omit)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\>
|
||||
|
||||
↳ **`AxiosDefaults`**
|
||||
|
||||
## Properties
|
||||
|
||||
### adapter
|
||||
|
||||
• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.adapter
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:75
|
||||
|
||||
___
|
||||
|
||||
### auth
|
||||
|
||||
• `Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.auth
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:76
|
||||
|
||||
___
|
||||
|
||||
### baseURL
|
||||
|
||||
• `Optional` **baseURL**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.baseURL
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:65
|
||||
|
||||
___
|
||||
|
||||
### cancelToken
|
||||
|
||||
• `Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.cancelToken
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• `Optional` **data**: `D`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.data
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:71
|
||||
|
||||
___
|
||||
|
||||
### decompress
|
||||
|
||||
• `Optional` **decompress**: `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.decompress
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### headers
|
||||
|
||||
• **headers**: [`HeadersDefaults`](internal.HeadersDefaults.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:112
|
||||
|
||||
___
|
||||
|
||||
### httpAgent
|
||||
|
||||
• `Optional` **httpAgent**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.httpAgent
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### httpsAgent
|
||||
|
||||
• `Optional` **httpsAgent**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.httpsAgent
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:88
|
||||
|
||||
___
|
||||
|
||||
### insecureHTTPParser
|
||||
|
||||
• `Optional` **insecureHTTPParser**: `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.insecureHTTPParser
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
### maxBodyLength
|
||||
|
||||
• `Optional` **maxBodyLength**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.maxBodyLength
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### maxContentLength
|
||||
|
||||
• `Optional` **maxContentLength**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.maxContentLength
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
### maxRedirects
|
||||
|
||||
• `Optional` **maxRedirects**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.maxRedirects
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:85
|
||||
|
||||
___
|
||||
|
||||
### method
|
||||
|
||||
• `Optional` **method**: [`Method`](../modules/internal.md#method)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.method
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:64
|
||||
|
||||
___
|
||||
|
||||
### params
|
||||
|
||||
• `Optional` **params**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.params
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### proxy
|
||||
|
||||
• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.proxy
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### raxConfig
|
||||
|
||||
• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.raxConfig
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### responseType
|
||||
|
||||
• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.responseType
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:77
|
||||
|
||||
___
|
||||
|
||||
### signal
|
||||
|
||||
• `Optional` **signal**: [`AbortSignal`](../modules/internal.md#abortsignal)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.signal
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:93
|
||||
|
||||
___
|
||||
|
||||
### socketPath
|
||||
|
||||
• `Optional` **socketPath**: ``null`` \| `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.socketPath
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### timeout
|
||||
|
||||
• `Optional` **timeout**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.timeout
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:72
|
||||
|
||||
___
|
||||
|
||||
### timeoutErrorMessage
|
||||
|
||||
• `Optional` **timeoutErrorMessage**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.timeoutErrorMessage
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:73
|
||||
|
||||
___
|
||||
|
||||
### transformRequest
|
||||
|
||||
• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.transformRequest
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:66
|
||||
|
||||
___
|
||||
|
||||
### transformResponse
|
||||
|
||||
• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.transformResponse
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:67
|
||||
|
||||
___
|
||||
|
||||
### transitional
|
||||
|
||||
• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.transitional
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
### url
|
||||
|
||||
• `Optional` **url**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.url
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:63
|
||||
|
||||
___
|
||||
|
||||
### validateStatus
|
||||
|
||||
• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.validateStatus
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
### withCredentials
|
||||
|
||||
• `Optional` **withCredentials**: `boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.withCredentials
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:74
|
||||
|
||||
___
|
||||
|
||||
### xsrfCookieName
|
||||
|
||||
• `Optional` **xsrfCookieName**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.xsrfCookieName
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:78
|
||||
|
||||
___
|
||||
|
||||
### xsrfHeaderName
|
||||
|
||||
• `Optional` **xsrfHeaderName**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.xsrfHeaderName
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:79
|
||||
|
||||
## Methods
|
||||
|
||||
### onDownloadProgress
|
||||
|
||||
▸ `Optional` **onDownloadProgress**(`progressEvent`): `void`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `progressEvent` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.onDownloadProgress
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:81
|
||||
|
||||
___
|
||||
|
||||
### onUploadProgress
|
||||
|
||||
▸ `Optional` **onUploadProgress**(`progressEvent`): `void`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `progressEvent` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.onUploadProgress
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:80
|
||||
|
||||
___
|
||||
|
||||
### paramsSerializer
|
||||
|
||||
▸ `Optional` **paramsSerializer**(`params`): `string`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `params` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Omit.paramsSerializer
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:70
|
||||
@@ -0,0 +1,126 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosError<T, D\>
|
||||
|
||||
[internal](../modules/internal.md).AxiosError
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `D` | `any` |
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`Error`](../modules/internal.md#error)
|
||||
|
||||
↳ **`AxiosError`**
|
||||
|
||||
## Properties
|
||||
|
||||
### code
|
||||
|
||||
• `Optional` **code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:126
|
||||
|
||||
___
|
||||
|
||||
### config
|
||||
|
||||
• **config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:125
|
||||
|
||||
___
|
||||
|
||||
### isAxiosError
|
||||
|
||||
• **isAxiosError**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:129
|
||||
|
||||
___
|
||||
|
||||
### message
|
||||
|
||||
• **message**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Error.message
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1023
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Error.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1022
|
||||
|
||||
___
|
||||
|
||||
### request
|
||||
|
||||
• `Optional` **request**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:127
|
||||
|
||||
___
|
||||
|
||||
### response
|
||||
|
||||
• `Optional` **response**: [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `D`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:128
|
||||
|
||||
___
|
||||
|
||||
### stack
|
||||
|
||||
• `Optional` **stack**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
Error.stack
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1024
|
||||
|
||||
## Methods
|
||||
|
||||
### toJSON
|
||||
|
||||
▸ **toJSON**(): `object`
|
||||
|
||||
#### Returns
|
||||
|
||||
`object`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:130
|
||||
@@ -0,0 +1,377 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosInstance
|
||||
|
||||
[internal](../modules/internal.md).AxiosInstance
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`Axios`](../classes/internal.Axios.md)
|
||||
|
||||
↳ **`AxiosInstance`**
|
||||
|
||||
## Callable
|
||||
|
||||
### AxiosInstance
|
||||
|
||||
▸ **AxiosInstance**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:188
|
||||
|
||||
### AxiosInstance
|
||||
|
||||
▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`AxiosPromise`](internal.AxiosPromise.md)<`any`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:189
|
||||
|
||||
## Properties
|
||||
|
||||
### defaults
|
||||
|
||||
• **defaults**: [`AxiosDefaults`](internal.AxiosDefaults.md)<`any`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[defaults](../classes/internal.Axios.md#defaults)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:171
|
||||
|
||||
___
|
||||
|
||||
### interceptors
|
||||
|
||||
• **interceptors**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `request` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\>\> |
|
||||
| `response` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosResponse`](internal.AxiosResponse.md)<`any`, `any`\>\> |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[interceptors](../classes/internal.Axios.md#interceptors)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:172
|
||||
|
||||
## Methods
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[delete](../classes/internal.Axios.md#delete)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:179
|
||||
|
||||
___
|
||||
|
||||
### get
|
||||
|
||||
▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[get](../classes/internal.Axios.md#get)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:178
|
||||
|
||||
___
|
||||
|
||||
### getUri
|
||||
|
||||
▸ **getUri**(`config?`): `string`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[getUri](../classes/internal.Axios.md#geturi)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:176
|
||||
|
||||
___
|
||||
|
||||
### head
|
||||
|
||||
▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[head](../classes/internal.Axios.md#head)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:180
|
||||
|
||||
___
|
||||
|
||||
### options
|
||||
|
||||
▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[options](../classes/internal.Axios.md#options)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:181
|
||||
|
||||
___
|
||||
|
||||
### patch
|
||||
|
||||
▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `data?` | `D` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[patch](../classes/internal.Axios.md#patch)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:184
|
||||
|
||||
___
|
||||
|
||||
### post
|
||||
|
||||
▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `data?` | `D` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[post](../classes/internal.Axios.md#post)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:182
|
||||
|
||||
___
|
||||
|
||||
### put
|
||||
|
||||
▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `data?` | `D` |
|
||||
| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[put](../classes/internal.Axios.md#put)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:183
|
||||
|
||||
___
|
||||
|
||||
### request
|
||||
|
||||
▸ **request**<`T`, `R`, `D`\>(`config`): [`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`R`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Axios](../classes/internal.Axios.md).[request](../classes/internal.Axios.md#request)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:177
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosInterceptorManager<V\>
|
||||
|
||||
[internal](../modules/internal.md).AxiosInterceptorManager
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `V` |
|
||||
|
||||
## Methods
|
||||
|
||||
### eject
|
||||
|
||||
▸ **eject**(`id`): `void`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `number` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:166
|
||||
|
||||
___
|
||||
|
||||
### use
|
||||
|
||||
▸ **use**<`T`\>(`onFulfilled?`, `onRejected?`): `number`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `V` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `onFulfilled?` | (`value`: `V`) => `T` \| [`Promise`](../modules/internal.md#promise)<`T`\> |
|
||||
| `onRejected?` | (`error`: `any`) => `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:165
|
||||
@@ -0,0 +1,132 @@
|
||||
---
|
||||
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
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosProxyConfig
|
||||
|
||||
[internal](../modules/internal.md).AxiosProxyConfig
|
||||
|
||||
## Properties
|
||||
|
||||
### auth
|
||||
|
||||
• `Optional` **auth**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `password` | `string` |
|
||||
| `username` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:29
|
||||
|
||||
___
|
||||
|
||||
### host
|
||||
|
||||
• **host**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:27
|
||||
|
||||
___
|
||||
|
||||
### port
|
||||
|
||||
• **port**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:28
|
||||
|
||||
___
|
||||
|
||||
### protocol
|
||||
|
||||
• `Optional` **protocol**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:33
|
||||
@@ -0,0 +1,373 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosRequestConfig<D\>
|
||||
|
||||
[internal](../modules/internal.md).AxiosRequestConfig
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `D` | `any` |
|
||||
|
||||
## Properties
|
||||
|
||||
### adapter
|
||||
|
||||
• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:75
|
||||
|
||||
___
|
||||
|
||||
### auth
|
||||
|
||||
• `Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:76
|
||||
|
||||
___
|
||||
|
||||
### baseURL
|
||||
|
||||
• `Optional` **baseURL**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:65
|
||||
|
||||
___
|
||||
|
||||
### cancelToken
|
||||
|
||||
• `Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• `Optional` **data**: `D`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:71
|
||||
|
||||
___
|
||||
|
||||
### decompress
|
||||
|
||||
• `Optional` **decompress**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### headers
|
||||
|
||||
• `Optional` **headers**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:68
|
||||
|
||||
___
|
||||
|
||||
### httpAgent
|
||||
|
||||
• `Optional` **httpAgent**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### httpsAgent
|
||||
|
||||
• `Optional` **httpsAgent**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:88
|
||||
|
||||
___
|
||||
|
||||
### insecureHTTPParser
|
||||
|
||||
• `Optional` **insecureHTTPParser**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
### maxBodyLength
|
||||
|
||||
• `Optional` **maxBodyLength**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### maxContentLength
|
||||
|
||||
• `Optional` **maxContentLength**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
### maxRedirects
|
||||
|
||||
• `Optional` **maxRedirects**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:85
|
||||
|
||||
___
|
||||
|
||||
### method
|
||||
|
||||
• `Optional` **method**: [`Method`](../modules/internal.md#method)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:64
|
||||
|
||||
___
|
||||
|
||||
### params
|
||||
|
||||
• `Optional` **params**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### proxy
|
||||
|
||||
• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### raxConfig
|
||||
|
||||
• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### responseType
|
||||
|
||||
• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:77
|
||||
|
||||
___
|
||||
|
||||
### signal
|
||||
|
||||
• `Optional` **signal**: [`AbortSignal`](../modules/internal.md#abortsignal)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:93
|
||||
|
||||
___
|
||||
|
||||
### socketPath
|
||||
|
||||
• `Optional` **socketPath**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### timeout
|
||||
|
||||
• `Optional` **timeout**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:72
|
||||
|
||||
___
|
||||
|
||||
### timeoutErrorMessage
|
||||
|
||||
• `Optional` **timeoutErrorMessage**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:73
|
||||
|
||||
___
|
||||
|
||||
### transformRequest
|
||||
|
||||
• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:66
|
||||
|
||||
___
|
||||
|
||||
### transformResponse
|
||||
|
||||
• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:67
|
||||
|
||||
___
|
||||
|
||||
### transitional
|
||||
|
||||
• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
### url
|
||||
|
||||
• `Optional` **url**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:63
|
||||
|
||||
___
|
||||
|
||||
### validateStatus
|
||||
|
||||
• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
### withCredentials
|
||||
|
||||
• `Optional` **withCredentials**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:74
|
||||
|
||||
___
|
||||
|
||||
### xsrfCookieName
|
||||
|
||||
• `Optional` **xsrfCookieName**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:78
|
||||
|
||||
___
|
||||
|
||||
### xsrfHeaderName
|
||||
|
||||
• `Optional` **xsrfHeaderName**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:79
|
||||
|
||||
## Methods
|
||||
|
||||
### onDownloadProgress
|
||||
|
||||
▸ `Optional` **onDownloadProgress**(`progressEvent`): `void`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `progressEvent` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:81
|
||||
|
||||
___
|
||||
|
||||
### onUploadProgress
|
||||
|
||||
▸ `Optional` **onUploadProgress**(`progressEvent`): `void`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `progressEvent` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:80
|
||||
|
||||
___
|
||||
|
||||
### paramsSerializer
|
||||
|
||||
▸ `Optional` **paramsSerializer**(`params`): `string`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `params` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:70
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosRequestTransformer
|
||||
|
||||
[internal](../modules/internal.md).AxiosRequestTransformer
|
||||
|
||||
## Callable
|
||||
|
||||
### AxiosRequestTransformer
|
||||
|
||||
▸ **AxiosRequestTransformer**(`data`, `headers?`): `any`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `data` | `any` |
|
||||
| `headers?` | [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) |
|
||||
|
||||
#### Returns
|
||||
|
||||
`any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:10
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosResponse<T, D\>
|
||||
|
||||
[internal](../modules/internal.md).AxiosResponse
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `D` | `any` |
|
||||
|
||||
## Properties
|
||||
|
||||
### config
|
||||
|
||||
• **config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:120
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `T`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:116
|
||||
|
||||
___
|
||||
|
||||
### headers
|
||||
|
||||
• **headers**: [`AxiosResponseHeaders`](../modules/internal.md#axiosresponseheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:119
|
||||
|
||||
___
|
||||
|
||||
### request
|
||||
|
||||
• `Optional` **request**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:121
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:117
|
||||
|
||||
___
|
||||
|
||||
### statusText
|
||||
|
||||
• **statusText**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:118
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: AxiosResponseTransformer
|
||||
|
||||
[internal](../modules/internal.md).AxiosResponseTransformer
|
||||
|
||||
## Callable
|
||||
|
||||
### AxiosResponseTransformer
|
||||
|
||||
▸ **AxiosResponseTransformer**(`data`, `headers?`): `any`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `data` | `any` |
|
||||
| `headers?` | [`AxiosResponseHeaders`](../modules/internal.md#axiosresponseheaders) |
|
||||
|
||||
#### Returns
|
||||
|
||||
`any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:14
|
||||
@@ -0,0 +1,222 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: CallSite
|
||||
|
||||
[internal](../modules/internal.md).CallSite
|
||||
|
||||
## Methods
|
||||
|
||||
### getColumnNumber
|
||||
|
||||
▸ **getColumnNumber**(): ``null`` \| `number`
|
||||
|
||||
Current column number [if this function was defined in a script]
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:154
|
||||
|
||||
___
|
||||
|
||||
### getEvalOrigin
|
||||
|
||||
▸ **getEvalOrigin**(): `undefined` \| `string`
|
||||
|
||||
A call site object representing the location where eval was called
|
||||
[if this function was created using a call to eval]
|
||||
|
||||
#### Returns
|
||||
|
||||
`undefined` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:160
|
||||
|
||||
___
|
||||
|
||||
### getFileName
|
||||
|
||||
▸ **getFileName**(): ``null`` \| `string`
|
||||
|
||||
Name of the script [if this function was defined in a script]
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:144
|
||||
|
||||
___
|
||||
|
||||
### getFunction
|
||||
|
||||
▸ **getFunction**(): `undefined` \| [`Function`](../modules/internal.md#function)
|
||||
|
||||
Current function
|
||||
|
||||
#### Returns
|
||||
|
||||
`undefined` \| [`Function`](../modules/internal.md#function)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:126
|
||||
|
||||
___
|
||||
|
||||
### getFunctionName
|
||||
|
||||
▸ **getFunctionName**(): ``null`` \| `string`
|
||||
|
||||
Name of the current function, typically its name property.
|
||||
If a name property is not available an attempt will be made to try
|
||||
to infer a name from the function's context.
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:133
|
||||
|
||||
___
|
||||
|
||||
### getLineNumber
|
||||
|
||||
▸ **getLineNumber**(): ``null`` \| `number`
|
||||
|
||||
Current line number [if this function was defined in a script]
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:149
|
||||
|
||||
___
|
||||
|
||||
### getMethodName
|
||||
|
||||
▸ **getMethodName**(): ``null`` \| `string`
|
||||
|
||||
Name of the property [of "this" or one of its prototypes] that holds
|
||||
the current function
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:139
|
||||
|
||||
___
|
||||
|
||||
### getThis
|
||||
|
||||
▸ **getThis**(): `unknown`
|
||||
|
||||
Value of "this"
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:113
|
||||
|
||||
___
|
||||
|
||||
### getTypeName
|
||||
|
||||
▸ **getTypeName**(): ``null`` \| `string`
|
||||
|
||||
Type of "this" as a string.
|
||||
This is the name of the function stored in the constructor field of
|
||||
"this", if available. Otherwise the object's [[Class]] internal
|
||||
property.
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:121
|
||||
|
||||
___
|
||||
|
||||
### isConstructor
|
||||
|
||||
▸ **isConstructor**(): `boolean`
|
||||
|
||||
Is this a constructor call?
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:180
|
||||
|
||||
___
|
||||
|
||||
### isEval
|
||||
|
||||
▸ **isEval**(): `boolean`
|
||||
|
||||
Does this call take place in code defined by a call to eval?
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:170
|
||||
|
||||
___
|
||||
|
||||
### isNative
|
||||
|
||||
▸ **isNative**(): `boolean`
|
||||
|
||||
Is this call in native V8 code?
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:175
|
||||
|
||||
___
|
||||
|
||||
### isToplevel
|
||||
|
||||
▸ **isToplevel**(): `boolean`
|
||||
|
||||
Is this a toplevel invocation, that is, is "this" the global object?
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:165
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Cancel
|
||||
|
||||
[internal](../modules/internal.md).Cancel
|
||||
|
||||
## Properties
|
||||
|
||||
### message
|
||||
|
||||
• **message**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:141
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: CancelToken
|
||||
|
||||
[internal](../modules/internal.md).CancelToken
|
||||
|
||||
## Properties
|
||||
|
||||
### promise
|
||||
|
||||
• **promise**: [`Promise`](../modules/internal.md#promise)<[`Cancel`](internal.Cancel.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:154
|
||||
|
||||
___
|
||||
|
||||
### reason
|
||||
|
||||
• `Optional` **reason**: [`Cancel`](internal.Cancel.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:155
|
||||
|
||||
## Methods
|
||||
|
||||
### throwIfRequested
|
||||
|
||||
▸ **throwIfRequested**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:156
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Config
|
||||
|
||||
[internal](../modules/internal.md).Config
|
||||
|
||||
## Properties
|
||||
|
||||
### apiKey
|
||||
|
||||
• `Optional` **apiKey**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/request.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### baseUrl
|
||||
|
||||
• **baseUrl**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/request.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### maxRetries
|
||||
|
||||
• **maxRetries**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/request.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L13)
|
||||
948
docs/content/references/js-client/interfaces/internal.Date.md
Normal file
948
docs/content/references/js-client/interfaces/internal.Date.md
Normal file
@@ -0,0 +1,948 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Date
|
||||
|
||||
[internal](../modules/internal.md).Date
|
||||
|
||||
Enables basic storage and retrieval of dates and times.
|
||||
|
||||
## Methods
|
||||
|
||||
### [toPrimitive]
|
||||
|
||||
▸ **[toPrimitive]**(`hint`): `string`
|
||||
|
||||
Converts a Date object to a string.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `hint` | ``"default"`` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:114
|
||||
|
||||
▸ **[toPrimitive]**(`hint`): `string`
|
||||
|
||||
Converts a Date object to a string.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `hint` | ``"string"`` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:118
|
||||
|
||||
▸ **[toPrimitive]**(`hint`): `number`
|
||||
|
||||
Converts a Date object to a number.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `hint` | ``"number"`` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:122
|
||||
|
||||
▸ **[toPrimitive]**(`hint`): `string` \| `number`
|
||||
|
||||
Converts a Date object to a string or number.
|
||||
|
||||
**`throws`** {TypeError} If 'hint' was given something other than "number", "string", or "default".
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `hint` | `string` | The strings "number", "string", or "default" to specify what primitive to return. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string` \| `number`
|
||||
|
||||
A number if 'hint' was "number", a string if 'hint' was "string" or "default".
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:131
|
||||
|
||||
___
|
||||
|
||||
### getDate
|
||||
|
||||
▸ **getDate**(): `number`
|
||||
|
||||
Gets the day-of-the-month, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:775
|
||||
|
||||
___
|
||||
|
||||
### getDay
|
||||
|
||||
▸ **getDay**(): `number`
|
||||
|
||||
Gets the day of the week, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:779
|
||||
|
||||
___
|
||||
|
||||
### getFullYear
|
||||
|
||||
▸ **getFullYear**(): `number`
|
||||
|
||||
Gets the year, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:767
|
||||
|
||||
___
|
||||
|
||||
### getHours
|
||||
|
||||
▸ **getHours**(): `number`
|
||||
|
||||
Gets the hours in a date, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:783
|
||||
|
||||
___
|
||||
|
||||
### getMilliseconds
|
||||
|
||||
▸ **getMilliseconds**(): `number`
|
||||
|
||||
Gets the milliseconds of a Date, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:795
|
||||
|
||||
___
|
||||
|
||||
### getMinutes
|
||||
|
||||
▸ **getMinutes**(): `number`
|
||||
|
||||
Gets the minutes of a Date object, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:787
|
||||
|
||||
___
|
||||
|
||||
### getMonth
|
||||
|
||||
▸ **getMonth**(): `number`
|
||||
|
||||
Gets the month, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:771
|
||||
|
||||
___
|
||||
|
||||
### getSeconds
|
||||
|
||||
▸ **getSeconds**(): `number`
|
||||
|
||||
Gets the seconds of a Date object, using local time.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:791
|
||||
|
||||
___
|
||||
|
||||
### getTime
|
||||
|
||||
▸ **getTime**(): `number`
|
||||
|
||||
Gets the time value in milliseconds.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:765
|
||||
|
||||
___
|
||||
|
||||
### getTimezoneOffset
|
||||
|
||||
▸ **getTimezoneOffset**(): `number`
|
||||
|
||||
Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:799
|
||||
|
||||
___
|
||||
|
||||
### getUTCDate
|
||||
|
||||
▸ **getUTCDate**(): `number`
|
||||
|
||||
Gets the day-of-the-month, using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:777
|
||||
|
||||
___
|
||||
|
||||
### getUTCDay
|
||||
|
||||
▸ **getUTCDay**(): `number`
|
||||
|
||||
Gets the day of the week using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:781
|
||||
|
||||
___
|
||||
|
||||
### getUTCFullYear
|
||||
|
||||
▸ **getUTCFullYear**(): `number`
|
||||
|
||||
Gets the year using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:769
|
||||
|
||||
___
|
||||
|
||||
### getUTCHours
|
||||
|
||||
▸ **getUTCHours**(): `number`
|
||||
|
||||
Gets the hours value in a Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:785
|
||||
|
||||
___
|
||||
|
||||
### getUTCMilliseconds
|
||||
|
||||
▸ **getUTCMilliseconds**(): `number`
|
||||
|
||||
Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:797
|
||||
|
||||
___
|
||||
|
||||
### getUTCMinutes
|
||||
|
||||
▸ **getUTCMinutes**(): `number`
|
||||
|
||||
Gets the minutes of a Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:789
|
||||
|
||||
___
|
||||
|
||||
### getUTCMonth
|
||||
|
||||
▸ **getUTCMonth**(): `number`
|
||||
|
||||
Gets the month of a Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:773
|
||||
|
||||
___
|
||||
|
||||
### getUTCSeconds
|
||||
|
||||
▸ **getUTCSeconds**(): `number`
|
||||
|
||||
Gets the seconds of a Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:793
|
||||
|
||||
___
|
||||
|
||||
### setDate
|
||||
|
||||
▸ **setDate**(`date`): `number`
|
||||
|
||||
Sets the numeric day-of-the-month value of the Date object using local time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `date` | `number` | A numeric value equal to the day of the month. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:862
|
||||
|
||||
___
|
||||
|
||||
### setFullYear
|
||||
|
||||
▸ **setFullYear**(`year`, `month?`, `date?`): `number`
|
||||
|
||||
Sets the year of the Date object using local time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `year` | `number` | A numeric value for the year. |
|
||||
| `month?` | `number` | A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified. |
|
||||
| `date?` | `number` | A numeric value equal for the day of the month. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:886
|
||||
|
||||
___
|
||||
|
||||
### setHours
|
||||
|
||||
▸ **setHours**(`hours`, `min?`, `sec?`, `ms?`): `number`
|
||||
|
||||
Sets the hour value in the Date object using local time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `hours` | `number` | A numeric value equal to the hours value. |
|
||||
| `min?` | `number` | A numeric value equal to the minutes value. |
|
||||
| `sec?` | `number` | A numeric value equal to the seconds value. |
|
||||
| `ms?` | `number` | A numeric value equal to the milliseconds value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:849
|
||||
|
||||
___
|
||||
|
||||
### setMilliseconds
|
||||
|
||||
▸ **setMilliseconds**(`ms`): `number`
|
||||
|
||||
Sets the milliseconds value in the Date object using local time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `ms` | `number` | A numeric value equal to the millisecond value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:809
|
||||
|
||||
___
|
||||
|
||||
### setMinutes
|
||||
|
||||
▸ **setMinutes**(`min`, `sec?`, `ms?`): `number`
|
||||
|
||||
Sets the minutes value in the Date object using local time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `min` | `number` | A numeric value equal to the minutes value. |
|
||||
| `sec?` | `number` | A numeric value equal to the seconds value. |
|
||||
| `ms?` | `number` | A numeric value equal to the milliseconds value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:834
|
||||
|
||||
___
|
||||
|
||||
### setMonth
|
||||
|
||||
▸ **setMonth**(`month`, `date?`): `number`
|
||||
|
||||
Sets the month value in the Date object using local time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `month` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. |
|
||||
| `date?` | `number` | A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:873
|
||||
|
||||
___
|
||||
|
||||
### setSeconds
|
||||
|
||||
▸ **setSeconds**(`sec`, `ms?`): `number`
|
||||
|
||||
Sets the seconds value in the Date object using local time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `sec` | `number` | A numeric value equal to the seconds value. |
|
||||
| `ms?` | `number` | A numeric value equal to the milliseconds value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:821
|
||||
|
||||
___
|
||||
|
||||
### setTime
|
||||
|
||||
▸ **setTime**(`time`): `number`
|
||||
|
||||
Sets the date and time value in the Date object.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `time` | `number` | A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:804
|
||||
|
||||
___
|
||||
|
||||
### setUTCDate
|
||||
|
||||
▸ **setUTCDate**(`date`): `number`
|
||||
|
||||
Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `date` | `number` | A numeric value equal to the day of the month. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:867
|
||||
|
||||
___
|
||||
|
||||
### setUTCFullYear
|
||||
|
||||
▸ **setUTCFullYear**(`year`, `month?`, `date?`): `number`
|
||||
|
||||
Sets the year value in the Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `year` | `number` | A numeric value equal to the year. |
|
||||
| `month?` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied. |
|
||||
| `date?` | `number` | A numeric value equal to the day of the month. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:893
|
||||
|
||||
___
|
||||
|
||||
### setUTCHours
|
||||
|
||||
▸ **setUTCHours**(`hours`, `min?`, `sec?`, `ms?`): `number`
|
||||
|
||||
Sets the hours value in the Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `hours` | `number` | A numeric value equal to the hours value. |
|
||||
| `min?` | `number` | A numeric value equal to the minutes value. |
|
||||
| `sec?` | `number` | A numeric value equal to the seconds value. |
|
||||
| `ms?` | `number` | A numeric value equal to the milliseconds value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:857
|
||||
|
||||
___
|
||||
|
||||
### setUTCMilliseconds
|
||||
|
||||
▸ **setUTCMilliseconds**(`ms`): `number`
|
||||
|
||||
Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `ms` | `number` | A numeric value equal to the millisecond value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:814
|
||||
|
||||
___
|
||||
|
||||
### setUTCMinutes
|
||||
|
||||
▸ **setUTCMinutes**(`min`, `sec?`, `ms?`): `number`
|
||||
|
||||
Sets the minutes value in the Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `min` | `number` | A numeric value equal to the minutes value. |
|
||||
| `sec?` | `number` | A numeric value equal to the seconds value. |
|
||||
| `ms?` | `number` | A numeric value equal to the milliseconds value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:841
|
||||
|
||||
___
|
||||
|
||||
### setUTCMonth
|
||||
|
||||
▸ **setUTCMonth**(`month`, `date?`): `number`
|
||||
|
||||
Sets the month value in the Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `month` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. |
|
||||
| `date?` | `number` | A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:879
|
||||
|
||||
___
|
||||
|
||||
### setUTCSeconds
|
||||
|
||||
▸ **setUTCSeconds**(`sec`, `ms?`): `number`
|
||||
|
||||
Sets the seconds value in the Date object using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `sec` | `number` | A numeric value equal to the seconds value. |
|
||||
| `ms?` | `number` | A numeric value equal to the milliseconds value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:827
|
||||
|
||||
___
|
||||
|
||||
### toDateString
|
||||
|
||||
▸ **toDateString**(): `string`
|
||||
|
||||
Returns a date as a string value.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:753
|
||||
|
||||
___
|
||||
|
||||
### toISOString
|
||||
|
||||
▸ **toISOString**(): `string`
|
||||
|
||||
Returns a date as a string value in ISO format.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:897
|
||||
|
||||
___
|
||||
|
||||
### toJSON
|
||||
|
||||
▸ **toJSON**(`key?`): `string`
|
||||
|
||||
Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `key?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:899
|
||||
|
||||
___
|
||||
|
||||
### toLocaleDateString
|
||||
|
||||
▸ **toLocaleDateString**(): `string`
|
||||
|
||||
Returns a date as a string value appropriate to the host environment's current locale.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:759
|
||||
|
||||
▸ **toLocaleDateString**(`locales?`, `options?`): `string`
|
||||
|
||||
Converts a date to a string by using the current or specified locale.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. |
|
||||
| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4487
|
||||
|
||||
___
|
||||
|
||||
### toLocaleString
|
||||
|
||||
▸ **toLocaleString**(): `string`
|
||||
|
||||
Returns a value as a string value appropriate to the host environment's current locale.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:757
|
||||
|
||||
▸ **toLocaleString**(`locales?`, `options?`): `string`
|
||||
|
||||
Converts a date and time to a string by using the current or specified locale.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. |
|
||||
| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4481
|
||||
|
||||
___
|
||||
|
||||
### toLocaleTimeString
|
||||
|
||||
▸ **toLocaleTimeString**(): `string`
|
||||
|
||||
Returns a time as a string value appropriate to the host environment's current locale.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:761
|
||||
|
||||
▸ **toLocaleTimeString**(`locales?`, `options?`): `string`
|
||||
|
||||
Converts a time to a string by using the current or specified locale.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. |
|
||||
| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4494
|
||||
|
||||
___
|
||||
|
||||
### toString
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
Returns a string representation of a date. The format of the string depends on the locale.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:751
|
||||
|
||||
___
|
||||
|
||||
### toTimeString
|
||||
|
||||
▸ **toTimeString**(): `string`
|
||||
|
||||
Returns a time as a string value.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:755
|
||||
|
||||
___
|
||||
|
||||
### toUTCString
|
||||
|
||||
▸ **toUTCString**(): `string`
|
||||
|
||||
Returns a date converted to a string using Universal Coordinated Time (UTC).
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:895
|
||||
|
||||
___
|
||||
|
||||
### valueOf
|
||||
|
||||
▸ **valueOf**(): `number`
|
||||
|
||||
Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:763
|
||||
@@ -0,0 +1,95 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: DateConstructor
|
||||
|
||||
[internal](../modules/internal.md).DateConstructor
|
||||
|
||||
## Callable
|
||||
|
||||
### DateConstructor
|
||||
|
||||
▸ **DateConstructor**(): `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:906
|
||||
|
||||
## Properties
|
||||
|
||||
### prototype
|
||||
|
||||
• `Readonly` **prototype**: [`Date`](../modules/internal.md#date)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:907
|
||||
|
||||
## Methods
|
||||
|
||||
### UTC
|
||||
|
||||
▸ **UTC**(`year`, `month`, `date?`, `hours?`, `minutes?`, `seconds?`, `ms?`): `number`
|
||||
|
||||
Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `year` | `number` | The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. |
|
||||
| `month` | `number` | The month as a number between 0 and 11 (January to December). |
|
||||
| `date?` | `number` | The date as a number between 1 and 31. |
|
||||
| `hours?` | `number` | Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour. |
|
||||
| `minutes?` | `number` | Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes. |
|
||||
| `seconds?` | `number` | Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds. |
|
||||
| `ms?` | `number` | A number from 0 to 999 that specifies the milliseconds. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:923
|
||||
|
||||
___
|
||||
|
||||
### now
|
||||
|
||||
▸ **now**(): `number`
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:924
|
||||
|
||||
___
|
||||
|
||||
### parse
|
||||
|
||||
▸ **parse**(`s`): `number`
|
||||
|
||||
Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `s` | `string` | A date string |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:912
|
||||
@@ -0,0 +1,197 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: DateTimeFormatOptions
|
||||
|
||||
[internal](../modules/internal.md).DateTimeFormatOptions
|
||||
|
||||
## Properties
|
||||
|
||||
### calendar
|
||||
|
||||
• `Optional` **calendar**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.intl.d.ts:237
|
||||
|
||||
___
|
||||
|
||||
### dateStyle
|
||||
|
||||
• `Optional` **dateStyle**: ``"long"`` \| ``"short"`` \| ``"full"`` \| ``"medium"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.intl.d.ts:241
|
||||
|
||||
___
|
||||
|
||||
### day
|
||||
|
||||
• `Optional` **day**: ``"numeric"`` \| ``"2-digit"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4418
|
||||
|
||||
___
|
||||
|
||||
### dayPeriod
|
||||
|
||||
• `Optional` **dayPeriod**: ``"long"`` \| ``"short"`` \| ``"narrow"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.intl.d.ts:238
|
||||
|
||||
___
|
||||
|
||||
### era
|
||||
|
||||
• `Optional` **era**: ``"long"`` \| ``"short"`` \| ``"narrow"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4415
|
||||
|
||||
___
|
||||
|
||||
### formatMatcher
|
||||
|
||||
• `Optional` **formatMatcher**: ``"best fit"`` \| ``"basic"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4423
|
||||
|
||||
___
|
||||
|
||||
### hour
|
||||
|
||||
• `Optional` **hour**: ``"numeric"`` \| ``"2-digit"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4419
|
||||
|
||||
___
|
||||
|
||||
### hour12
|
||||
|
||||
• `Optional` **hour12**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4424
|
||||
|
||||
___
|
||||
|
||||
### hourCycle
|
||||
|
||||
• `Optional` **hourCycle**: ``"h11"`` \| ``"h12"`` \| ``"h23"`` \| ``"h24"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.intl.d.ts:243
|
||||
|
||||
___
|
||||
|
||||
### localeMatcher
|
||||
|
||||
• `Optional` **localeMatcher**: ``"best fit"`` \| ``"lookup"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4413
|
||||
|
||||
___
|
||||
|
||||
### minute
|
||||
|
||||
• `Optional` **minute**: ``"numeric"`` \| ``"2-digit"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4420
|
||||
|
||||
___
|
||||
|
||||
### month
|
||||
|
||||
• `Optional` **month**: ``"long"`` \| ``"short"`` \| ``"narrow"`` \| ``"numeric"`` \| ``"2-digit"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4417
|
||||
|
||||
___
|
||||
|
||||
### numberingSystem
|
||||
|
||||
• `Optional` **numberingSystem**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.intl.d.ts:239
|
||||
|
||||
___
|
||||
|
||||
### second
|
||||
|
||||
• `Optional` **second**: ``"numeric"`` \| ``"2-digit"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4421
|
||||
|
||||
___
|
||||
|
||||
### timeStyle
|
||||
|
||||
• `Optional` **timeStyle**: ``"long"`` \| ``"short"`` \| ``"full"`` \| ``"medium"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.intl.d.ts:242
|
||||
|
||||
___
|
||||
|
||||
### timeZone
|
||||
|
||||
• `Optional` **timeZone**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4425
|
||||
|
||||
___
|
||||
|
||||
### timeZoneName
|
||||
|
||||
• `Optional` **timeZoneName**: ``"long"`` \| ``"short"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4422
|
||||
|
||||
___
|
||||
|
||||
### weekday
|
||||
|
||||
• `Optional` **weekday**: ``"long"`` \| ``"short"`` \| ``"narrow"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4414
|
||||
|
||||
___
|
||||
|
||||
### year
|
||||
|
||||
• `Optional` **year**: ``"numeric"`` \| ``"2-digit"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:4416
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Error
|
||||
|
||||
[internal](../modules/internal.md).Error
|
||||
|
||||
## Properties
|
||||
|
||||
### message
|
||||
|
||||
• **message**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1023
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1022
|
||||
|
||||
___
|
||||
|
||||
### stack
|
||||
|
||||
• `Optional` **stack**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1024
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: ErrorConstructor
|
||||
|
||||
[internal](../modules/internal.md).ErrorConstructor
|
||||
|
||||
## Callable
|
||||
|
||||
### ErrorConstructor
|
||||
|
||||
▸ **ErrorConstructor**(`message?`): [`Error`](../modules/internal.md#error)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `message?` | `string` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Error`](../modules/internal.md#error)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1029
|
||||
|
||||
## Properties
|
||||
|
||||
### prepareStackTrace
|
||||
|
||||
• `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/internal.md#error), `stackTraces`: [`CallSite`](internal.CallSite.md)[]) => `any`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`err`, `stackTraces`): `any`
|
||||
|
||||
Optional override for formatting stack traces
|
||||
|
||||
**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | [`Error`](../modules/internal.md#error) |
|
||||
| `stackTraces` | [`CallSite`](internal.CallSite.md)[] |
|
||||
|
||||
##### Returns
|
||||
|
||||
`any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### prototype
|
||||
|
||||
• `Readonly` **prototype**: [`Error`](../modules/internal.md#error)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1030
|
||||
|
||||
___
|
||||
|
||||
### stackTraceLimit
|
||||
|
||||
• **stackTraceLimit**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:13
|
||||
|
||||
## Methods
|
||||
|
||||
### captureStackTrace
|
||||
|
||||
▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
|
||||
|
||||
Create .stack property on a target object
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `targetObject` | `object` |
|
||||
| `constructorOpt?` | [`Function`](../modules/internal.md#function) |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/@types/node/globals.d.ts:4
|
||||
@@ -0,0 +1,176 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Function
|
||||
|
||||
[internal](../modules/internal.md).Function
|
||||
|
||||
Creates a new function.
|
||||
|
||||
## Properties
|
||||
|
||||
### arguments
|
||||
|
||||
• **arguments**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:304
|
||||
|
||||
___
|
||||
|
||||
### caller
|
||||
|
||||
• **caller**: [`Function`](../modules/internal.md#function)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:305
|
||||
|
||||
___
|
||||
|
||||
### length
|
||||
|
||||
• `Readonly` **length**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:301
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• `Readonly` **name**: `string`
|
||||
|
||||
Returns the name of the function. Function names are read-only and can not be changed.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.core.d.ts:97
|
||||
|
||||
___
|
||||
|
||||
### prototype
|
||||
|
||||
• **prototype**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:300
|
||||
|
||||
## Methods
|
||||
|
||||
### [hasInstance]
|
||||
|
||||
▸ **[hasInstance]**(`value`): `boolean`
|
||||
|
||||
Determines whether the given value inherits from this function if this function was used
|
||||
as a constructor function.
|
||||
|
||||
A constructor function can control which objects are recognized as its instances by
|
||||
'instanceof' by overriding this method.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `value` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:162
|
||||
|
||||
___
|
||||
|
||||
### apply
|
||||
|
||||
▸ **apply**(`this`, `thisArg`, `argArray?`): `any`
|
||||
|
||||
Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `this` | [`Function`](../modules/internal.md#function) | - |
|
||||
| `thisArg` | `any` | The object to be used as the this object. |
|
||||
| `argArray?` | `any` | A set of arguments to be passed to the function. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:280
|
||||
|
||||
___
|
||||
|
||||
### bind
|
||||
|
||||
▸ **bind**(`this`, `thisArg`, ...`argArray`): `any`
|
||||
|
||||
For a given function, creates a bound function that has the same body as the original function.
|
||||
The this object of the bound function is associated with the specified object, and has the specified initial parameters.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `this` | [`Function`](../modules/internal.md#function) | - |
|
||||
| `thisArg` | `any` | An object to which the this keyword can refer inside the new function. |
|
||||
| `...argArray` | `any`[] | A list of arguments to be passed to the new function. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:295
|
||||
|
||||
___
|
||||
|
||||
### call
|
||||
|
||||
▸ **call**(`this`, `thisArg`, ...`argArray`): `any`
|
||||
|
||||
Calls a method of an object, substituting another object for the current object.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `this` | [`Function`](../modules/internal.md#function) | - |
|
||||
| `thisArg` | `any` | The object to be used as the current object. |
|
||||
| `...argArray` | `any`[] | A list of arguments to be passed to the method. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:287
|
||||
|
||||
___
|
||||
|
||||
### toString
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
Returns a string representation of a function.
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:298
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: FunctionConstructor
|
||||
|
||||
[internal](../modules/internal.md).FunctionConstructor
|
||||
|
||||
## Callable
|
||||
|
||||
### FunctionConstructor
|
||||
|
||||
▸ **FunctionConstructor**(...`args`): [`Function`](../modules/internal.md#function)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `...args` | `string`[] |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Function`](../modules/internal.md#function)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:314
|
||||
|
||||
## Properties
|
||||
|
||||
### prototype
|
||||
|
||||
• `Readonly` **prototype**: [`Function`](../modules/internal.md#function)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:315
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: HTTPResponse
|
||||
|
||||
[internal](../modules/internal.md).HTTPResponse
|
||||
|
||||
## Properties
|
||||
|
||||
### config
|
||||
|
||||
• **config**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### headers
|
||||
|
||||
• **headers**: [`Record`](../modules/internal.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
### request
|
||||
|
||||
• `Optional` **request**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L8)
|
||||
|
||||
___
|
||||
|
||||
### statusText
|
||||
|
||||
• **statusText**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L9)
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: HeadersDefaults
|
||||
|
||||
[internal](../modules/internal.md).HeadersDefaults
|
||||
|
||||
## Properties
|
||||
|
||||
### common
|
||||
|
||||
• **common**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:98
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
• **delete**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:99
|
||||
|
||||
___
|
||||
|
||||
### get
|
||||
|
||||
• **get**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:100
|
||||
|
||||
___
|
||||
|
||||
### head
|
||||
|
||||
• **head**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:101
|
||||
|
||||
___
|
||||
|
||||
### link
|
||||
|
||||
• `Optional` **link**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:107
|
||||
|
||||
___
|
||||
|
||||
### options
|
||||
|
||||
• `Optional` **options**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:105
|
||||
|
||||
___
|
||||
|
||||
### patch
|
||||
|
||||
• **patch**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:104
|
||||
|
||||
___
|
||||
|
||||
### post
|
||||
|
||||
• **post**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:102
|
||||
|
||||
___
|
||||
|
||||
### purge
|
||||
|
||||
• `Optional` **purge**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:106
|
||||
|
||||
___
|
||||
|
||||
### put
|
||||
|
||||
• **put**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:103
|
||||
|
||||
___
|
||||
|
||||
### unlink
|
||||
|
||||
• `Optional` **unlink**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:108
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Iterable<T\>
|
||||
|
||||
[internal](../modules/internal.md).Iterable
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
## Methods
|
||||
|
||||
### [iterator]
|
||||
|
||||
▸ **[iterator]**(): [`Iterator`](internal.Iterator.md)<`T`, `any`, `undefined`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Iterator`](internal.Iterator.md)<`T`, `any`, `undefined`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:51
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Iterator<T, TReturn, TNext\>
|
||||
|
||||
[internal](../modules/internal.md).Iterator
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `T` |
|
||||
| `TReturn` | `any` |
|
||||
| `TNext` | `undefined` |
|
||||
|
||||
## Methods
|
||||
|
||||
### next
|
||||
|
||||
▸ **next**(...`args`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `...args` | [] \| [`TNext`] |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:45
|
||||
|
||||
___
|
||||
|
||||
### return
|
||||
|
||||
▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `value?` | `TReturn` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:46
|
||||
|
||||
___
|
||||
|
||||
### throw
|
||||
|
||||
▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `e?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:47
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: IteratorReturnResult<TReturn\>
|
||||
|
||||
[internal](../modules/internal.md).IteratorReturnResult
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `TReturn` |
|
||||
|
||||
## Properties
|
||||
|
||||
### done
|
||||
|
||||
• **done**: ``true``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:37
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `TReturn`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:38
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: IteratorYieldResult<TYield\>
|
||||
|
||||
[internal](../modules/internal.md).IteratorYieldResult
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `TYield` |
|
||||
|
||||
## Properties
|
||||
|
||||
### done
|
||||
|
||||
• `Optional` **done**: ``false``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:32
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `TYield`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:33
|
||||
112
docs/content/references/js-client/interfaces/internal.Promise.md
Normal file
112
docs/content/references/js-client/interfaces/internal.Promise.md
Normal file
@@ -0,0 +1,112 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: Promise<T\>
|
||||
|
||||
[internal](../modules/internal.md).Promise
|
||||
|
||||
Represents the completion of an asynchronous operation
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
## Properties
|
||||
|
||||
### [toStringTag]
|
||||
|
||||
• `Readonly` **[toStringTag]**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174
|
||||
|
||||
## Methods
|
||||
|
||||
### catch
|
||||
|
||||
▸ **catch**<`TResult`\>(`onrejected?`): [`Promise`](../modules/internal.md#promise)<`T` \| `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)<`T` \| `TResult`\>
|
||||
|
||||
A Promise for the completion of the callback.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1509
|
||||
|
||||
___
|
||||
|
||||
### finally
|
||||
|
||||
▸ **finally**(`onfinally?`): [`Promise`](../modules/internal.md#promise)<`T`\>
|
||||
|
||||
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)<`T`\>
|
||||
|
||||
A Promise for the completion of the callback.
|
||||
|
||||
#### 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` | `T` |
|
||||
| `TResult2` | `never` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `onfulfilled?` | ``null`` \| (`value`: `T`) => `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.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1502
|
||||
@@ -0,0 +1,277 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: PromiseConstructor
|
||||
|
||||
[internal](../modules/internal.md).PromiseConstructor
|
||||
|
||||
## Properties
|
||||
|
||||
### [species]
|
||||
|
||||
• `Readonly` **[species]**: [`PromiseConstructor`](internal.PromiseConstructor.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:178
|
||||
|
||||
___
|
||||
|
||||
### prototype
|
||||
|
||||
• `Readonly` **prototype**: [`Promise`](../modules/internal.md#promise)<`any`\>
|
||||
|
||||
A reference to the prototype.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.promise.d.ts:25
|
||||
|
||||
## Methods
|
||||
|
||||
### all
|
||||
|
||||
▸ **all**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>[]\>
|
||||
|
||||
Creates a Promise that is resolved with an array of results when all of the provided Promises
|
||||
resolve, or rejected when any Promise is rejected.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An iterable of Promises. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>[]\>
|
||||
|
||||
A new Promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:226
|
||||
|
||||
▸ **all**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: Awaited<T[P]\> }\>
|
||||
|
||||
Creates a Promise that is resolved with an array of results when all of the provided Promises
|
||||
resolve, or rejected when any Promise is rejected.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends readonly `unknown`[] \| [] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `values` | `T` | An array of Promises. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: Awaited<T[P]\> }\>
|
||||
|
||||
A new Promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.promise.d.ts:41
|
||||
|
||||
___
|
||||
|
||||
### allSettled
|
||||
|
||||
▸ **allSettled**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: PromiseSettledResult<Awaited<T[P]\>\> }\>
|
||||
|
||||
Creates a Promise that is resolved with an array of results when all
|
||||
of the provided Promises resolve or reject.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends readonly `unknown`[] \| [] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `values` | `T` | An array of Promises. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: PromiseSettledResult<Awaited<T[P]\>\> }\>
|
||||
|
||||
A new Promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.promise.d.ts:40
|
||||
|
||||
▸ **allSettled**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`PromiseSettledResult`](../modules/internal.md#promisesettledresult)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>[]\>
|
||||
|
||||
Creates a Promise that is resolved with an array of results when all
|
||||
of the provided Promises resolve or reject.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An array of Promises. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<[`PromiseSettledResult`](../modules/internal.md#promisesettledresult)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>[]\>
|
||||
|
||||
A new Promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.promise.d.ts:48
|
||||
|
||||
___
|
||||
|
||||
### race
|
||||
|
||||
▸ **race**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>
|
||||
|
||||
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
|
||||
or rejected.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An iterable of Promises. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>
|
||||
|
||||
A new Promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.iterable.d.ts:234
|
||||
|
||||
▸ **race**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`[`number`]\>\>
|
||||
|
||||
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
|
||||
or rejected.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends readonly `unknown`[] \| [] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `values` | `T` | An array of Promises. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`[`number`]\>\>
|
||||
|
||||
A new Promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.promise.d.ts:52
|
||||
|
||||
___
|
||||
|
||||
### reject
|
||||
|
||||
▸ **reject**<`T`\>(`reason?`): [`Promise`](../modules/internal.md#promise)<`T`\>
|
||||
|
||||
Creates a new rejected promise for the provided reason.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `never` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `reason?` | `any` | The reason the promise was rejected. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`T`\>
|
||||
|
||||
A new rejected Promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.promise.d.ts:62
|
||||
|
||||
___
|
||||
|
||||
### resolve
|
||||
|
||||
▸ **resolve**(): [`Promise`](../modules/internal.md#promise)<`void`\>
|
||||
|
||||
Creates a new resolved promise.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`void`\>
|
||||
|
||||
A resolved promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.promise.d.ts:68
|
||||
|
||||
▸ **resolve**<`T`\>(`value`): [`Promise`](../modules/internal.md#promise)<`T`\>
|
||||
|
||||
Creates a new resolved promise for the provided value.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `value` | `T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\> | A promise. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Promise`](../modules/internal.md#promise)<`T`\>
|
||||
|
||||
A promise whose internal state matches the provided promise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2015.promise.d.ts:75
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: PromiseFulfilledResult<T\>
|
||||
|
||||
[internal](../modules/internal.md).PromiseFulfilledResult
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
## Properties
|
||||
|
||||
### status
|
||||
|
||||
• **status**: ``"fulfilled"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.promise.d.ts:22
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `T`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.promise.d.ts:23
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: PromiseLike<T\>
|
||||
|
||||
[internal](../modules/internal.md).PromiseLike
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
## Methods
|
||||
|
||||
### then
|
||||
|
||||
▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](internal.PromiseLike.md)<`TResult1` \| `TResult2`\>
|
||||
|
||||
Attaches callbacks for the resolution and/or rejection of the Promise.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `TResult1` | `T` |
|
||||
| `TResult2` | `never` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `onfulfilled?` | ``null`` \| (`value`: `T`) => `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
|
||||
|
||||
[`PromiseLike`](internal.PromiseLike.md)<`TResult1` \| `TResult2`\>
|
||||
|
||||
A Promise for the completion of which ever callback is executed.
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es5.d.ts:1489
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: PromiseRejectedResult
|
||||
|
||||
[internal](../modules/internal.md).PromiseRejectedResult
|
||||
|
||||
## Properties
|
||||
|
||||
### reason
|
||||
|
||||
• **reason**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.promise.d.ts:28
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: ``"rejected"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
node_modules/typescript/lib/lib.es2020.promise.d.ts:27
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: RequestOptions
|
||||
|
||||
[internal](../modules/internal.md).RequestOptions
|
||||
|
||||
## Properties
|
||||
|
||||
### numberOfRetries
|
||||
|
||||
• `Optional` **numberOfRetries**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### timeout
|
||||
|
||||
• `Optional` **timeout**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L17)
|
||||
@@ -0,0 +1,187 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: RetryConfig
|
||||
|
||||
[internal](../modules/internal.md).RetryConfig
|
||||
|
||||
Configuration for the Axios `request` method.
|
||||
|
||||
## Properties
|
||||
|
||||
### backoffType
|
||||
|
||||
• `Optional` **backoffType**: ``"linear"`` \| ``"static"`` \| ``"exponential"``
|
||||
|
||||
Backoff Type; 'linear', 'static' or 'exponential'.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47
|
||||
|
||||
___
|
||||
|
||||
### checkRetryAfter
|
||||
|
||||
• `Optional` **checkRetryAfter**: `boolean`
|
||||
|
||||
Whether to check for 'Retry-After' header in response and use value as delay. Defaults to true.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51
|
||||
|
||||
___
|
||||
|
||||
### currentRetryAttempt
|
||||
|
||||
• `Optional` **currentRetryAttempt**: `number`
|
||||
|
||||
The number of retries already attempted.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### httpMethodsToRetry
|
||||
|
||||
• `Optional` **httpMethodsToRetry**: `string`[]
|
||||
|
||||
The HTTP Methods that will be automatically retried.
|
||||
Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE']
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26
|
||||
|
||||
___
|
||||
|
||||
### instance
|
||||
|
||||
• `Optional` **instance**: [`AxiosInstance`](internal.AxiosInstance.md)
|
||||
|
||||
The instance of the axios object to which the interceptor is attached.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### maxRetryAfter
|
||||
|
||||
• `Optional` **maxRetryAfter**: `number`
|
||||
|
||||
Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55
|
||||
|
||||
___
|
||||
|
||||
### maxRetryDelay
|
||||
|
||||
• `Optional` **maxRetryDelay**: `number`
|
||||
|
||||
Ceiling for calculated delay (in ms) - delay will not exceed this value.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59
|
||||
|
||||
___
|
||||
|
||||
### noResponseRetries
|
||||
|
||||
• `Optional` **noResponseRetries**: `number`
|
||||
|
||||
When there is no response, the number of retries to attempt. Defaults to 2.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43
|
||||
|
||||
___
|
||||
|
||||
### retry
|
||||
|
||||
• `Optional` **retry**: `number`
|
||||
|
||||
The number of times to retry the request. Defaults to 3.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### retryDelay
|
||||
|
||||
• `Optional` **retryDelay**: `number`
|
||||
|
||||
The amount of time to initially delay the retry. Defaults to 100.
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### statusCodesToRetry
|
||||
|
||||
• `Optional` **statusCodesToRetry**: `number`[][]
|
||||
|
||||
The HTTP response status codes that will automatically be retried.
|
||||
Defaults to: [[100, 199], [429, 429], [500, 599]]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31
|
||||
|
||||
## Methods
|
||||
|
||||
### onRetryAttempt
|
||||
|
||||
▸ `Optional` **onRetryAttempt**(`err`): `void`
|
||||
|
||||
Function to invoke when a retry attempt is made.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35
|
||||
|
||||
___
|
||||
|
||||
### shouldRetry
|
||||
|
||||
▸ `Optional` **shouldRetry**(`err`): `boolean`
|
||||
|
||||
Function to invoke which determines if you should retry
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: TransitionalOptions
|
||||
|
||||
[internal](../modules/internal.md).TransitionalOptions
|
||||
|
||||
## Properties
|
||||
|
||||
### clarifyTimeoutError
|
||||
|
||||
• `Optional` **clarifyTimeoutError**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:59
|
||||
|
||||
___
|
||||
|
||||
### forcedJSONParsing
|
||||
|
||||
• `Optional` **forcedJSONParsing**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:58
|
||||
|
||||
___
|
||||
|
||||
### silentJSONParsing
|
||||
|
||||
• `Optional` **silentJSONParsing**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:57
|
||||
Reference in New Issue
Block a user