# disposable-event

> Events from all over the messy world, streamlined!

Latest version **2.0.0** (published 2021-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install disposable-event
pnpm add disposable-event
yarn add disposable-event
bun add disposable-event
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-06-15 |
| First published | 2016-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | steelbrain |
| Maintainers | steelbrain |
| Keywords | event, disposable |

## Links

- npm: https://www.npmjs.com/package/disposable-event
- Repository: https://github.com/steelbrain/disposable-event
- Issues: https://github.com/steelbrain/disposable-event/issues
- npm.io page: https://npm.io/package/disposable-event

## Dependencies (2)

- [event-kit](https://npm.io/package/event-kit.md) ^2.5.3
- [@types/event-kit](https://npm.io/package/@types/event-kit.md) ^2.4.0

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-06-15
- 1.1.0 — 2020-12-25
- 1.0.3 — 2016-09-24
- 1.0.2 — 2016-09-24
- 1.0.1 — 2016-07-16
- 1.0.0 — 2016-02-16

## README

# Disposable-Event

[![Greenkeeper badge](https://badges.greenkeeper.io/steelbrain/disposable-event.svg)](https://greenkeeper.io/)

`disposable-event` is an npm module built to normalize event registration and disposal. We have often dealt with situations where there are inconsistent ways to add or remove event listeners in different APIs, `disposable-event` normalizes them all and gives authors a beautiful API

## Installation

```
npm install --save disposable-event
```

## API

```
function disposableEvent(target, eventName, callback, options): Disposable
```

## Usage

```js
import disposableEvent from 'disposable-event'
import {Server} from 'ws'

// Adding listeners
const eventListeners = []
eventListeners.push(disposableEvent(document, 'click', function() {
  console.log('document was clicked')
}))
eventListeners.push(disposableEvent(document, 'keydown', function() {
  console.log('key was pressed')
}))

const server = new Server()
eventListeners.push(disposableEvent(server, 'error', function(error) {
  console.log('error occured', error)
}))

// Disposing listeners
eventListeners.forEach(disposable => disposable.dispose())
```

## License

This project is licensed under the terms of MIT License, see the LICENSE file for more info

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