# sesame-client

> Node.js client for Sesame smart lock API

Latest version **0.1.3** (published 2020-04-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install sesame-client
pnpm add sesame-client
yarn add sesame-client
bun add sesame-client
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2020-04-19 |
| First published | 2020-03-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.6 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yudai Nakata |
| Maintainers | yudai-nkt |
| Keywords | sesame, smart-lock, iot, smart-home, api, rest, bluetooth |

## Links

- npm: https://www.npmjs.com/package/sesame-client
- Repository: https://github.com/yudai-nkt/sesame-client
- Homepage: https://yudai-nkt.github.io/sesame-client
- Issues: https://github.com/yudai-nkt/sesame-client/issues
- npm.io page: https://npm.io/package/sesame-client

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.19.2
- [camelcase-keys](https://npm.io/package/camelcase-keys.md) ^6.2.1

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2020-04-19
- 0.1.2 — 2020-03-27
- 0.1.1 — 2020-03-26

## README

# sesame-client

[![NPM](https://img.shields.io/npm/v/sesame-client)](https://www.npmjs.com/package/sesame-client)
[![Node.js CI](https://github.com/yudai-nkt/sesame-client/workflows/Node.js%20CI/badge.svg)](https://github.com/yudai-nkt/sesame-client/actions?query=workflow%3A%22Node.js+CI%22)
[![Test coverage](https://img.shields.io/codecov/c/github/yudai-nkt/sesame-client?logo=codecov)](https://codecov.io/gh/yudai-nkt/sesame-client)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

Node.js client for Sesame smart lock API

```javascript
const sesame = require('sesame-client')
const myLock = new sesame.RestClient('API_TOKEN', 'DEVICE_ID')

async function toggle () {
  const currStatus = await myLock.getLockStatus()
  await myLock.controlLock(currStatus.locked ? 'unlock' : 'lock')
}
```

## Installation
Run the following command in your project root.

```console
npm install sesame-client
```

## Usage
See [API documentation][].

## Contribution
Contributions are welcome. Feel free to report an issue or submit a pull request.
 
## License
This package is distributed under the MIT License.
See [LICENSE.md](./LICENSE.md) for details.

## Reference
- Sesame smart lock API documentation: https://docs.candyhouse.co/

[API documentation]: https://yudai-nkt.github.io/sesame-client

---
_Source: https://npm.io/package/sesame-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._