# triggerest

Latest version **1.2.0** (published 2020-12-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install triggerest
pnpm add triggerest
yarn add triggerest
bun add triggerest
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-12-22 |
| First published | 2020-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Oktay Şenkan |
| Maintainers | oktaysenkan |
| Keywords | webhook, api, trigger |

## Links

- npm: https://www.npmjs.com/package/triggerest
- Repository: https://github.com/oktaysenkan/triggerest
- Homepage: https://github.com/oktaysenkan/triggerest#readme
- Issues: https://github.com/oktaysenkan/triggerest/issues
- npm.io page: https://npm.io/package/triggerest

## Dependencies (5)

- [faker](https://npm.io/package/faker.md) ^5.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [express](https://npm.io/package/express.md) ^4.17.1
- [ts-node](https://npm.io/package/ts-node.md) ^9.0.0
- [eventemitter3](https://npm.io/package/eventemitter3.md) ^4.0.7

## Recent versions

- 1.2.0 (latest) — 2020-12-22
- 1.1.0 — 2020-10-04
- 1.0.2 — 2020-10-04
- 1.0.0 — 2020-10-03
- 0.1.0 — 2020-10-03

## README

# triggerest

<p>
  <a href="https://www.npmjs.com/package/triggerest" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/triggerest?color=black" />
  </a>
  <a href="https://github.com/oktaysenkan/triggerest/blob/master/LICENSE" target="_blank">
    <img alt="License: ISC" src="https://img.shields.io/badge/License-MIT-black.svg" />
  </a>
  <a href="https://sonarcloud.io/dashboard?id=oktaysenkan_triggerest" target="_blank">
    <img alt="License: ISC" src="https://sonarcloud.io/api/project_badges/measure?project=oktaysenkan_triggerest&metric=alert_status" />
  </a>
</p>

## Install

```sh
npm install triggerest
```

## Usage

You can check [examples](https://github.com/oktaysenkan/triggerest/tree/master/examples)

```ts
const getTodos = async () => {
  const { data: todos } = await axios.get(
    'https://jsonplaceholder.typicode.com/todos'
  );

  return todos;
};

const triggerest = new Triggerest(getTodos, 'id');

triggerest.on('result', (items) => {
  console.log('result received');
});

triggerest.on('changed', (addedItems: any[], removedItems: any[]) => {
  console.log('items changed');
});

triggerest.on('added', (items) => {
  console.log('added', items);
});

triggerest.on('removed', (items) => {
  console.log('removed', items);
});
```

## License

[MIT](https://github.com/oktaysenkan/triggerest/blob/master/LICENSE)

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