# rx-event

> A very simple but powerful event pub/sub package with only 6 lines of source code. This package is built on top of `Rxjs`, so all the awesome `Rxjs` operators like `filter`, `debounce` are available. I find it much simpler to use than `EventEmitter`

Latest version **1.0.2** (published 2018-02-05) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-02-05 |
| First published | 2018-02-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Yong Wang |
| Maintainers | yongwangd |

## Links

- npm: https://www.npmjs.com/package/rx-event
- npm.io page: https://npm.io/package/rx-event

## Dependencies (2)

- [rxjs](https://npm.io/package/rxjs.md) ^5.5.6
- [rx-event](https://npm.io/package/rx-event.md) ^1.0.0

## Recent versions

- 1.0.2 (latest) — 2018-02-05
- 1.0.1 — 2018-02-05
- 1.0.0 — 2018-02-05

## README

# rx-event

A very simple but powerful event pub/sub package with only 6 lines of source code. This package is built on top of `Rxjs`, so all the awesome `Rxjs` operators like `filter`, `debounce` are available. I find it much simpler to use than `EventEmitter`

### Installing

```
npm i rx-event --save
```

Or if you use `yarn`

```
yarn add rx-event
```

## How to use

This package comes with 3 named exports and 1 default export

`emitEvent` : emit an event with optional payload

```js
emitEvent('user-request', 'john');
emitEvent('user-fetched', { name: 'John Doe', age: 26 });
emitEvent('user-fetched', { name: 'Jack Davis', age: 40 });
emitEvent('scroll-down');
```

`eventPayloadOfType$`: filter the `event$` to only get the payload of a specific event type

```js
eventPayloadOfType$('user-fetched');
// {name: 'John Doe', age: 26} .
// { name: 'Jack Davis', age: 40}
```

`eventOfTypes$`: filter the `event$` to only get the events whose type is includes in the argument list

```js
eventOfTypes$('click', 'scroll', 'mousedown');
```

`event$`: default export, it's the underlying event stream, which is basiclly a `Rxjs Subject` instance

# Complete examples

```js
import event$, {
  emitEvent,
  eventPayloadOfType$,
  eventOfTypes$
} from 'rx-event';

function emitSomeEvents() {
  emitEvent('user-request', 'john');
  emitEvent('user-fetched', { name: 'John Doe', age: 26 });
  emitEvent('user-fetched', { name: 'Jack Davis', age: 40 });
  emitEvent('scroll-down');
}

eventPayloadOfType$('user-fetched')
  .map(user => user.name)
  .subscribe(name => console.log(name));
/*
    John Doe
    Jack Davis
*/

eventOfTypes$('user-request', 'user-fetched').subscribe(events =>
  console.log(events)
);
/* output:
{ type: 'user-request', payload: 'john' }
{ type: 'user-fetched', payload: { name: 'John Doe', age: 26 } }
{ type: 'user-fetched', payload: { name: 'Jack Davis', age: 40 } }
*/

//get the events without payload
event$.filter(event => !event.payload).subscribe(user => console.log(user));
// { type: 'scroll-down' }

//emit an event on page scroll
window.addEventListener('scroll', e => emitEvent('scroll', e));
//debounce the scroll events with 300ms
eventPayloadOfType$('scroll')
  .debounceTime(300)
  .subscribe(e => console.log(e));

//autocomplete example.
document
  .getElementById('#search')
  .addEventListener('change', e => emitEvent('search-changed', e.value));

eventPayloadOfType$('search-changed')
  .debounceTime(500)
  .distinctUntilChanged()
  .switchMap(searchValue => searchWikiPedia(searchValue));

//call the function to emit some events
emitSomeEvents();
```

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