# brcast

> Tiny data broadcaster with 0 dependencies

Latest version **3.0.2** (published 2020-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install brcast
pnpm add brcast
yarn add brcast
bun add brcast
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2020-06-03 |
| First published | 2017-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 48 |
| Maintainers | vesparny |
| Keywords | events, eventemitter, pubsub, broadcast |

## Links

- npm: https://www.npmjs.com/package/brcast
- Repository: https://github.com/vesparny/brcast
- Issues: https://github.com/vesparny/brcast/issues
- npm.io page: https://npm.io/package/brcast

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

- 3.0.2 (latest) — 2020-06-03
- 3.0.1 — 2017-08-16
- 3.0.0 — 2017-08-02
- 2.0.2 — 2017-07-27
- 2.0.1 — 2017-06-28
- 2.0.0 — 2017-04-19
- 1.1.6 — 2017-04-08
- 1.1.4 — 2017-04-08
- 1.1.3 — 2017-04-07
- 1.1.2 — 2017-04-07
- 1.1.1 — 2017-04-07
- 1.1.0 — 2017-04-07

## README

# Brcast

> Tiny data broadcaster with 0 dependencies

[![Travis](https://img.shields.io/travis/vesparny/brcast.svg)](https://travis-ci.org/vesparny/brcast)
[![Code Coverage](https://img.shields.io/codecov/c/github/vesparny/brcast.svg?style=flat-square)](https://codecov.io/github/vesparny/brcast)
[![David](https://img.shields.io/david/vesparny/brcast.svg)](https://david-dm.org/vesparny/brcast)
[![npm](https://img.shields.io/npm/v/brcast.svg)](https://www.npmjs.com/package/brcast)
[![npm](https://img.shields.io/npm/dm/brcast.svg)](https://npm-stat.com/charts.html?package=brcast&from=2017-04-01)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
[![MIT License](https://img.shields.io/npm/l/brcast.svg?style=flat-square)](https://github.com/vesparny/brcast/blob/master/LICENSE)

The current size of `brcast/dist/brcast.umd.min.js` is:

[![gzip size](http://img.badgesize.io/https://unpkg.com/brcast/dist/brcast.umd.min.js?compression=gzip&label=gzip%20size&style=flat-square)](https://unpkg.com/brcast/dist/)

It's like a data store you can subscribe to, with a setter to pump data in.
For browsers and node.

## Table of Contents

-   [Install](#install)
-   [Usage](#usage)
-   [API](#api)
-   [Testing](#tests)
-   [License](#license)

## Install

This project uses [node](http://nodejs.org) and [npm](https://npmjs.com). Go check them out if you don't have them locally installed.

```sh
$ npm install --save brcast
```

Then with a module bundler like [rollup](http://rollupjs.org/) or [webpack](https://webpack.js.org/), use as you would anything else:

```javascript
// using ES6 modules
import brcast from 'brcast'

// using CommonJS modules
var brcast = require('brcast')
```

The [UMD](https://github.com/umdjs/umd) build is also available on [unpkg](https://unpkg.com):

```html
<script src="https://unpkg.com/brcast/dist/brcast.umd.js"></script>
```

You can find the library on `window.brcast`.

## Usage

```js
import brcast from 'brcast'

let broadcast = brcast()

// subscribe
const subscriptionId = broadcast.subscribe(state => console.log(state))

// setState sets the state and invoke all subscription callbacks passing in the state
broadcast.setState(1)

// setState returns the current state
broadcast.getState()

// unsubscribe to unbind the handler
broadcast.unsubscribe(subscriptionId)
```

## API

### `brcast([initialState])`

Creates a `broadcast` object.

#### Arguments

1 - [`initialState`] *(any)*: The initial state.

#### Returns

(`broadcast`): An object that holds the state.

### `broadcast.setState(state)`

Store the new state.

#### Arguments

1 - `state` *(any)*: The new state.

#### Returns

Nothing.

### `broadcast.getState()`

Get the stored state.

#### Returns

(`Any`): The stored state.

### `broadcast.subscribe(handler)`

Subscribe to state changes.

#### Arguments

1 - `handler` *(Function)*: The callback to be invoked any time the state changes.

#### Returns

(`Number`): The subscription id to be used to unsubscribe.

### `broadcast.unsubscribe(subscriptionId)`

Unsubscribe the change listener.

#### Arguments

1 - `subscriptionId` *(Number)*: The subscription id returned by subscribing.

#### Returns

Nothing.

## Tests

```sh
$ npm run test
```


[MIT License](LICENSE.md) © [Alessandro Arnodo](https://alessandro.arnodo.net/)

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