# disposable-emitter

> Disposable EventEmitter

Latest version **0.3.0** (published 2015-10-29) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2015-10-29 |
| First published | 2015-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ragg |
| Maintainers | ragg |
| Keywords | emitter, disposable |

## Links

- npm: https://www.npmjs.com/package/disposable-emitter
- Repository: https://github.com/Ragg-/DisposableEmitter
- Homepage: https://github.com/Ragg-/DisposableEmitter#readme
- Issues: https://github.com/Ragg-/DisposableEmitter/issues
- npm.io page: https://npm.io/package/disposable-emitter

## Dependencies (1)

- [event-kit-browserify](https://npm.io/package/event-kit-browserify.md) ^1.4.1

## 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

- 0.3.0 (latest) — 2015-10-29
- 0.2.1 — 2015-10-24
- 0.2.0 — 2015-10-21
- 0.1.2 — 2015-10-18
- 0.1.1 — 2015-10-18
- 0.1.0 — 2015-10-18

## README

# DisposableEmitter
An disposable-emitter powered by [event-kit]()

Respects : [eventemitter3](), [event-kit]()

[![Build Status](https://img.shields.io/travis/Ragg-/DisposableEmitter.svg)](https://travis-ci.org/Ragg-/DisposableEmitter)
![npm license](https://img.shields.io/npm/l/disposable-emitter.svg)
[![npm version](https://img.shields.io/npm/v/disposable-emitter.svg)](https://www.npmjs.com/package/disposable-emitter)
![npm dependencies](https://david-dm.org/Ragg-/DisposableEmitter.svg)

# Example
``` coffeescript
Emitter = require "disposable-emitter"

class SomeModule extends Emitter
someModule = new SomeModule

##
## Event listening
##

listener = ->
    console.log "Event emitted!"

disposer = someModule.on "event", listener


##
##　Stop listening
##

# EventEmitter style
someModule.off "event", listener

# DisposableEmitter style
disposer.dispose()


##
## Observe listener adding
##

# observeAddListener(event, args...)
someModule.lockAutoEmit "initialized", null, "arguments"

# This listener call immediaty.
someModule.once "initialized", (err, message) ->
    console.log err, message

setTimeout ->
    # This listener will be call after 1seconds
    someModule.on "initialized", (err, message) ->
        console.log err, message
, 1000


##
## Unobserve listener adding
##

someModule.unlockAutoEmit "initialized"

# It is not called until it is emitted "initialized" event.
someModule.on "initialized", (err, message) ->
    console.log err, message


##
## Remove all listeners
##

someModule.removeAllListeners()

# if you want dispose and disabled this instance.
# Use or extends dispose method instead of removeAllListeners.
someModule.dispose()

someModule.on "event", ->
# => Error "Emitter has been disposed" thrown.
```

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