# ts-event-dispatcher

> A generic Typescript EventDispatcher

Latest version **0.0.2** (published 2017-09-06) · GPL-3.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install ts-event-dispatcher
pnpm add ts-event-dispatcher
yarn add ts-event-dispatcher
bun add ts-event-dispatcher
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-09-06 |
| First published | 2017-09-06 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jeremy Daley |
| Maintainers | daleyjem |
| Keywords | typescript, angular, event, dispatch, dispatcher, eventdispatcher |

## Links

- npm: https://www.npmjs.com/package/ts-event-dispatcher
- Repository: https://github.com/daleyjem/event-dispatcher
- Homepage: https://github.com/daleyjem/event-dispatcher#readme
- Issues: https://github.com/daleyjem/event-dispatcher/issues
- npm.io page: https://npm.io/package/ts-event-dispatcher

## 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.0.2 (latest) — 2017-09-06
- 0.0.1 — 2017-09-06

## README

# event-dispatcher

A generic vehicle for dispatching and listening to events.

## Installation

```
npm install ts-event-dispatcher
```

## Objects

### EventDispatcher

#### addEventListener(type:string, callback:any)

#### removeEventListener(type:string, callback:any)

#### dispatchEvent(type:string)

### DispatchableEvent

## Usage

### Extending

```typescript
import { EventDispatcher, DispatchableEvent } from 'ts-event-dispatcher';

class SomeClassOrService extends EventDispatcher {
	public static MY_EVENT:string = 'my_event';

    construct(){
        super();
        
        setTimeout( () => {
        	this.dispatchEvent( new DispatchableEvent( SomeClassOrService.MY_EVENT ));
        }, 5000);
    }
}
```

### Consuming

```typescript
import DispatchableEvent from 'ts-event-dispatcher';
import SomeClassOrService from './some-class-or-service';

class SomeOtherClassOrService {
    constructor(
        private someClassOrService:SomeClassOrService;
    ){
        this.someClassOrService.addEventListener( SomeClassOrService.MY_EVENT, this.onMyEvent.bind( this ));
    }
    
    private onMyEvent(){
        console.log( 'MY_EVENT fired' );
    	this.someClassOrService.removeEventListener( SomeClassOrService.MY_EVENT, this.onMyEvent.bind( this ));
    }
}
```

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