https://github.com/bcherny/typed-rx-emitter
Typesafe RxJS-based EventEmitter
https://github.com/bcherny/typed-rx-emitter
emitter event eventemitter javascript rx rxjs typescript
Last synced: 6 months ago
JSON representation
Typesafe RxJS-based EventEmitter
- Host: GitHub
- URL: https://github.com/bcherny/typed-rx-emitter
- Owner: bcherny
- License: mit
- Created: 2017-02-09T00:55:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-14T09:22:16.000Z (almost 7 years ago)
- Last Synced: 2025-04-13T23:53:47.322Z (6 months ago)
- Topics: emitter, event, eventemitter, javascript, rx, rxjs, typescript
- Language: TypeScript
- Homepage:
- Size: 205 KB
- Stars: 27
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![Build Status][build]](https://circleci.com/gh/bcherny/typed-rx-emitter) [![npm]](https://www.npmjs.com/package/typed-rx-emitter) [![mit]](https://opensource.org/licenses/MIT) [![ts]](https://www.typescriptlang.org/) [![flow]](https://flow.org/)
[build]: https://img.shields.io/circleci/project/bcherny/typed-rx-emitter/master.svg?style=flat-square
[npm]: https://img.shields.io/npm/v/typed-rx-emitter.svg?style=flat-square
[mit]: https://img.shields.io/npm/l/typed-rx-emitter.svg?style=flat-square
[ts]: https://img.shields.io/badge/TypeScript-%E2%9C%93-007ACC.svg?style=flat-square
[flow]: https://img.shields.io/badge/Flow-%E2%9C%93-007ACC.svg?style=flat-square
## Highlights
- 100% typesafe:
- Statically enforces that channels in `.on()` are defined
- Statically enforces that channels in `.emit()` are defined
- Statically enforces that emitters are called with the correct data given their Message name
- Statically enforces that listeners are called with the correct data given their Message name
- Supports [all RxJS Observable methods](http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html)
- Supports RxJS versions 4, 5, and 6
- Preforms dynamic analysis to detect and warn about cycles in emitters
- 3.7kb gzipped & minified (using RxJS6), including RxJS
## Installation (with RxJS v5.x or v6.x - recommended)
```sh
# Using Yarn:
yarn add typed-rx-emitter rxjs
# Using NPM:
npm install typed-rx-emitter rxjs --save
```
## Installation (with RxJS v4.x)
```sh
# Using Yarn:
yarn add typed-rx-emitter@^0.3
# Using NPM:
npm install typed-rx-emitter@^0.3 --save
```
## Usage
```ts
import { Emitter } from 'typed-rx-emitter'
// Enumerate messages
type Messages = {
INCREMENT_COUNTER: number
OPEN_MODAL: boolean
}
const emitter = new Emitter()
// Listen on an event (basic)
emitter
.on('OPEN_MODAL')
.subscribe(_ => console.log(`Change modal visibility: ${_}`)) // _ is a boolean
// Listen on an event (advanced)
import { debounceTime, filter } from 'rxjs/operators'
emitter
.on('INCREMENT_COUNTER')
.pipe(
filter(_ => _ > 3), // _ is a number
debounceTime(100)
)
.subscribe(_ => console.log(`Counter incremented to ${_}`)) // _ is a number
// Listen on all events
emitter
.all()
.subscribe(() => console.log('Something changed'))
// Trigger an event - throws a compile time error unless id and value are set, and are of the right types
emitter.emit('OPEN_MODAL', true)
// Event is misspelled - throws a compile time error
emitter.emit('INCREMENT_CONTER')
```
See a complete browser usage example [here](https://github.com/bcherny/typed-rx-emitter/blob/master/browser-example).
## Options
`Emitter` takes an optional `options` argument. `options` is an object, and each key in the object is optional:
| Option | Default | Description |
|-|-|-|
| `Error` | `CyclicalDependencyError` | Custom Error subclass for cycle warning |
| `isDevMode` | `false` | Perform dynamic analysis to warn about cycles? |
## Tests
```sh
npm test
```