# what-happened

> ## Install

Latest version **1.0.0-alpha** (published 2016-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install what-happened
pnpm add what-happened
yarn add what-happened
bun add what-happened
```

## 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.0-alpha |
| Published | 2016-11-29 |
| First published | 2016-11-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | joblake07 |

## Links

- npm: https://www.npmjs.com/package/what-happened
- npm.io page: https://npm.io/package/what-happened

## Recent versions

- 1.0.0-alpha (latest) — 2016-11-29
- 0.0.1 — 2016-11-29

## README

# what-happened

## Install

```
npm i what-happened --save
```

## createDispatcher() => dispatcher
The `dispatcher` allows you to notify different parts of your application that an event occured.

```js
import { createDispatcher } from 'what-happened';

const dispatcher = createDispatcher();
```

### dispatcher.subscribe(eventHandler) => unsubscribe
Subscribe to future dispatched events. Returns a function that unsubscribes from future events. Don't forget to unsubscribe!

```js
const unsubscribe = dispatcher.subscribe((event) => {
  switch (event.type) {
    case 'ALERT': return alert(event.message);
    default: return console.warn(`${event.type} not handled`);
  }
});

```

### dispatcher.dispatch(event)
Dispatches an `event` to all subscribers. An `event` is a plain object with a `type` property.

```js
const button = document.createElement('button');
button.innerText = 'Yo!';

button.addEventListener('click', () => dispatcher.dispatch({
  type: 'ALERT',
  message: 'Yo!',
}));

document.body.appendChild(button);

```

## dispatcher.createStore([reducer], [initialState]) => store
A `store` manages the state of your application (or component). When an `event` occurs, the `store` updates it's `state` and notifies it's subscribers. The `reducer` is a function that takes the previous `state` and the dispatched `event` and returns the next `state` (default = `(state = [], event) => event`). Your store can be created with an `initialState` (default = `undefined`).

```js
import { createDispatcher, createStore } from 'what-happened';

const dispatcher = createDispatcher();

const store = dispatcher.createStore((state, event) => {
  if (event.type === 'RESIZE') {
    return {
      width: event.width,
      height: event.height,
    };
  }

  return state;
});

```

### store.subscribe(handler)
Subscribe to future state changes.

```js
const div = document.createElement('div');
document.body.appendChild(div);

store.subscribe(() => {
  const { width, height } = store.getState();
  div.innerText = `window size = ${width}x${height}`;
});

const handleResize = () => dispatcher.dispatch({
  type: 'RESIZE',
  width: window.innerWidth,
  height: window.innerHeight,
});

window.addEventListener('resize', handleResize);
handleResize(); // trigger initial resize
```

### store.destory()
Destroying the store will unsubscribe all subscribers and ignore future dispatched events. Destroy your store when it is no longer needed.

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