# node-cachet

> Simple tool for accessing the Cachet API

Latest version **1.0.0** (published 2016-12-31) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install node-cachet
pnpm add node-cachet
yarn add node-cachet
bun add node-cachet
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-12-31 |
| First published | 2016-12-31 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nicholas Anderson |
| Maintainers | nanderson |
| Keywords | cachet, cachethq |

## Links

- npm: https://www.npmjs.com/package/node-cachet
- Repository: https://github.com/nanderson94/node-cachet
- Homepage: https://github.com/nanderson94/node-cachet#readme
- Issues: https://github.com/nanderson94/node-cachet/issues
- npm.io page: https://npm.io/package/node-cachet

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-12-31

## README

# node-cachet
This is a fairly simple no-dependency API to [Cachet](https://cachethq.io/), the
open source status page system.

## Progress
This is a fairly new project, and I haven't yet fully completed it. Notable
to-do items include:
  - Incident Updates endpoint
  - Metrics endpoint
  - Subscribers endpoint
  - Actions endpoint
  - Better Testing

## Usage

To setup the client,
```javascript
const Cachet = require("node-cachet");
const client = new Cachet("https://demo.cachethq.io/", "9yMHsdioQosnyVK4iCVR");
```

To receive a list of all components. [Refer to Advanced API usage](https://docs.cachethq.io/docs/advanced-api-usage).
```javascript
client.components.list({
  "per_page": 5,
  "status": 2
}).then((result) => {
  console.log(result);
}).catch((error) => {
  console.error(error);
});
```

TODO: Update doc to show all of:
`client.{components,componentGroups,incidents}.{list,get,add,update,delete}.then().catch();`

## License

Copyright 2016 Nicholas Anderson

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

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