petstore-package-sdk
v1.23.456
Published
this is testing
Downloads
7
Readme
Getting Started with APIMATIC Calculator
Introduction
Simple calculator API hosted on APIMATIC
Install the Package
Run the following command from your project directory to install the package from npm:
npm install [email protected]
For additional package details, see the Npm page for the [email protected] npm.
Test the SDK
To validate the functionality of this SDK, you can execute all tests located in the test
directory. This SDK utilizes Jest
as both the testing framework and test runner.
To run the tests, navigate to the root directory of the SDK and execute the following command:
npm run test
Or you can also run tests with coverage report:
npm run test:coverage
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| environment
| Environment
| The API environment. Default: Environment.Production
|
| timeout
| number
| Timeout for API calls.Default: 0
|
| httpClientOptions
| Partial<HttpClientOptions>
| Stable configurable http client options. |
| unstableHttpClientOptions
| any
| Unstable configurable http client options. |
HttpClientOptions
| 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. |
RetryConfiguration
| 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,
environment: Environment.Production,
});