3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
4.6 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: Client
internal.Client
Properties
axiosClient
• Private axiosClient: AxiosInstance
Defined in
packages/medusa-js/src/request.ts:29
config
• Private config: Config
Defined in
packages/medusa-js/src/request.ts:30
Methods
createClient
▸ createClient(config): AxiosInstance
Creates the axios client used for requests As part of the creation, we configure the retry conditions and the exponential backoff approach.
Parameters
| Name | Type | Description |
|---|---|---|
config |
Config |
user supplied configurations |
Returns
Defined in
packages/medusa-js/src/request.ts:146
normalizeHeader
▸ normalizeHeader(header): string
Parameters
| Name | Type |
|---|---|
header |
string |
Returns
string
Defined in
packages/medusa-js/src/request.ts:83
normalizeHeaders
▸ normalizeHeaders(obj): Record<string, any>
Parameters
| Name | Type |
|---|---|
obj |
object |
Returns
Record<string, any>
Defined in
packages/medusa-js/src/request.ts:71
request
▸ request(method, path, payload?, options?, customHeaders?): Promise<any>
Axios request
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
method |
RequestMethod |
undefined |
request method |
path |
string |
undefined |
request path |
payload |
null | Record<string, any> |
null |
request payload |
options |
RequestOptions |
{} |
axios configuration |
customHeaders |
Record<string, any> |
{} |
custom request headers |
Returns
Promise<any>
Defined in
packages/medusa-js/src/request.ts:183
requiresAuthentication
▸ requiresAuthentication(path, method): boolean
Parameters
| Name | Type |
|---|---|
path |
any |
method |
any |
Returns
boolean
Defined in
packages/medusa-js/src/request.ts:92
setHeaders
▸ setHeaders(userHeaders, method, path, customHeaders?): AxiosRequestHeaders
Creates all the initial headers. We add the idempotency key, if the request is configured to retry.
Parameters
| Name | Type | Description |
|---|---|---|
userHeaders |
RequestOptions |
user supplied headers |
method |
RequestMethod |
request method |
path |
string |
request path |
customHeaders |
Record<string, any> |
user supplied headers |
Returns
Defined in
packages/medusa-js/src/request.ts:108
shouldRetryCondition
▸ shouldRetryCondition(err, numRetries, maxRetries): boolean
Parameters
| Name | Type |
|---|---|
err |
AxiosError<any, any> |
numRetries |
number |
maxRetries |
number |
Returns
boolean