The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
timeout |
number |
Timeout for API calls. Default: 0 |
httpClientOptions |
Partial<HttpClientOptions> |
Stable configurable http client options. |
unstableHttpClientOptions |
any |
Unstable configurable http client options. |
xRapidAPIKey |
string |
Your Rapid API Key |
| Parameter | Type | Description |
|---|---|---|
timeout |
number |
Timeout in milliseconds. |
httpAgent |
any |
Custom http agent to be used when performing http requests. |
httpsAgent |
any |
Custom https agent to be used when performing http requests. |
retryConfig |
Partial<RetryConfiguration> |
Configurations to retry requests. |
| Parameter | Type | Description |
|---|---|---|
maxNumberOfRetries |
number |
Maximum number of retries. Default: 0 |
retryOnTimeout |
boolean |
Whether to retry on request timeout. Default: true |
retryInterval |
number |
Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1 |
maximumRetryWaitTime |
number |
Overall wait time for the requests getting retried. Default: 0 |
backoffFactor |
number |
Used in calculation of wait time for next request in case of failure. Default: 2 |
httpStatusCodesToRetry |
number[] |
Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
httpMethodsToRetry |
HttpMethod[] |
Http methods to retry against. Default: ['GET', 'PUT'] |
The API client can be initialized as follows:
const client = new Client({
timeout: 0,
xRapidAPIKey: 'X-RapidAPI-Key',
})
The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.
| Name | Description |
|---|---|
| credentials | Gets CredentialsController |
| feedback | Gets FeedbackController |