https://github.com/dvcol/withings-http-client
Fetch based http client for withings API
https://github.com/dvcol/withings-http-client
Last synced: 6 months ago
JSON representation
Fetch based http client for withings API
- Host: GitHub
- URL: https://github.com/dvcol/withings-http-client
- Owner: dvcol
- License: mit
- Created: 2024-05-12T22:22:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-20T17:55:45.000Z (almost 2 years ago)
- Last Synced: 2025-09-20T08:23:29.987Z (9 months ago)
- Language: TypeScript
- Size: 606 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
@dvcol/withings-http-client
> Simple fetch based http client for Withings API with full typescript support (request and response).
## Prerequisites
- pnpm >=9.0.0
- node >=20.0.0
## Install
```sh
pnpm install
```
## Usage
```sh
pnpm add @dvcol/withings-http-client
```
### Modular endpoint bundling
withings-http-client is designed to be modular and flexible. Although it uses static classes, endpoints are instantiated at runtime and can be easily omitted, extended or overridden.
If your bundler does not support tree-shaking, you can omit unused endpoints by only importing the ones you need.
By default we provide a [full api](https://github.com/dvcol/withings-http-client/blob/main/lib/api/withings-api.endpoints.ts) object with all supported endpoints, as well as a [minimal api](https://github.com/dvcol/withings-http-client/blob/main/lib/api/withings-api-minimal.endpoint.ts) object with only the essential authentication endpoints.
You can also import any [endpoint by common scope](https://github.com/dvcol/withings-http-client/tree/main/lib/api/endpoints).
```ts
import { WithingsClient } from '@dvcol/withings-http-client';
import { withingsApi } from '@dvcol/withings-http-client/api';
import { minimalWithingsApi } from '@dvcol/withings-http-client/api/minimal';
import { sleep } from '@dvcol/withings-http-client/api/sleep';
import { Config } from '@dvcol/withings-http-client/config';
import type { WithingsClientSettings } from '@dvcol/withings-http-client/models';
export const api = {
...minimalWithingsApi,
sleep
};
export const settings: WithingsClientSettings = {
client_id: '',
client_secret: '',
endpoint: Config.endpoint,
redirect_uri: '',
corsProxy: '',
corsPrefix: ''
};
const authenticaiton = {}
const client = new WithingsClient(settings, authenticaiton, api);
```
### Features
* [Built-in cache support](https://github.com/dvcol/base-http-client/blob/ed17c369f3cdf93656568373fc2dba841050e427/lib/client/base-client.test.ts#L235-L484) (per client, endpoint, or query)
* [Extensible cache store](https://github.com/dvcol/base-http-client/blob/ed17c369f3cdf93656568373fc2dba841050e427/lib/client/base-client.test.ts#L186-L194) (in-memory, local storage, etc.)
* [Event observer](https://github.com/dvcol/base-http-client/blob/ed17c369f3cdf93656568373fc2dba841050e427/lib/client/base-client.test.ts#L486-L575) (request, query, auth)
* [Built-in cancellation support](https://github.com/dvcol/base-http-client/blob/ed17c369f3cdf93656568373fc2dba841050e427/lib/client/base-client.test.ts#L691-L758)
* [Built-in cors proxy support](https://github.com/dvcol/base-http-client/blob/ed17c369f3cdf93656568373fc2dba841050e427/lib/models/base-client.model.ts#L14)
### Documentation
See [Withings API documentation](https://developer.withings.com/api-reference/) for more information.
## Author
* Github: [@dvcol](https://github.com/dvcol)
## 📝 License
This project is [MIT](https://github.com/dvcol/withings-http-client/blob/master/LICENSE) licensed.