https://github.com/goparrot/chowly-api-client
https://github.com/goparrot/chowly-api-client
library
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/goparrot/chowly-api-client
- Owner: goparrot
- Created: 2020-05-08T11:56:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-20T08:20:02.000Z (almost 5 years ago)
- Last Synced: 2025-08-08T16:55:05.580Z (11 months ago)
- Topics: library
- Language: TypeScript
- Size: 44.9 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Chowly Api Client
**Chowly Api Client** is a Typescript library which implements chowly api.
The library does not modify request and response payload.
* [Installation](#installation)
* [Usage](#usage)
* [Versioning](#versioning)
* [Contributing](#contributing)
* [Unit Tests](#unit-tests)
* [License](#license)
## Installation
```
npm i @goparrot/chowly-api-client
```
## Usage
### Simple example
```typescript
import { ChowlyApiClient, ICreateOrder } from '@goparrot/chowly-api-client';
const client = new ChowlyApiClient({
apiKey: 'test',
baseUrl: 'baseurl',
maxRetries: 5
});
// Get menu
client.getMenu()
.then(data => console.log(data))
.catch(error => console.log(error));
// Create order
const chowlyOrder: ICreateOrder = { /* Create order payload */ };
client.createOrder(chowlyOrder)
.then(data => console.log(data))
.catch(error => console.log(error));
// Get order
const orderId: string = 'chowly-order-id';
client.getOrder(orderId)
.then(data => console.log(data))
.catch(error => console.log(error));
```
## Available Options
### `ChowlyApiClient` Options
apyKey: string;
baseUrl: string;
maxRetries?: number;
| Name | Type | Default | Description |
| -------------- | ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| maxRetries | `Number` | `3` | The number of times to retry before failing. Also for control the delay between retried request is used the built-in `exponentialDelay` function is used ([Exponential Backoff](https://developers.google.com/analytics/devguides/reporting/core/v3/errors#backoff)). |
| baseUrl | `String` | 'https://api.chowlyinc.com' | The base URL against which to resolve every API call's (relative) path. |
| apiKey | `string` | | The string which represents token for getting data from chowly client |
## Versioning
Chowly Api Client follows [Semantic Versioning](http://semver.org/).
## Contributing
See [`CONTRIBUTING`](https://github.com/goparrot/chowly-api-client/blob/master/CONTRIBUTING.md#contributing) file.
## Unit Tests
In order to run the test suite, install the development dependencies:
```
npm i
```
Then, run the following command:
```
npm run coverage
```
## License
`@goparrot/chowly-api-client` is licensed under the [MIT license](LICENSE).