02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
4.2 KiB
4.2 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: Client
internal.Client
Properties
axiosClient
• Private axiosClient: AxiosInstance
Defined in
config
• Private config: Config
Defined in
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
normalizeHeader
▸ normalizeHeader(header): string
Parameters
| Name | Type |
|---|---|
header |
string |
Returns
string
Defined in
normalizeHeaders
▸ normalizeHeaders(obj): Record<string, any>
Parameters
| Name | Type |
|---|---|
obj |
object |
Returns
Record<string, any>
Defined in
request
▸ request(method, path, payload?, options?, customHeaders?): Promise<any>
Axios request
Parameters
| Name | Type | Description |
|---|---|---|
method |
RequestMethod |
request method |
path |
string |
request path |
payload |
Record<string, any> |
request payload |
options |
RequestOptions |
axios configuration |
customHeaders |
Record<string, any> |
custom request headers |
Returns
Promise<any>
Defined in
requiresAuthentication
▸ requiresAuthentication(path, method): boolean
Parameters
| Name | Type |
|---|---|
path |
any |
method |
any |
Returns
boolean
Defined in
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
shouldRetryCondition
▸ shouldRetryCondition(err, numRetries, maxRetries): boolean
Parameters
| Name | Type |
|---|---|
err |
AxiosError<any, any> |
numRetries |
number |
maxRetries |
number |
Returns
boolean