# electron-pubsub

> Pubsub for electron

Latest version **0.2.2** (published 2017-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install electron-pubsub
pnpm add electron-pubsub
yarn add electron-pubsub
bun add electron-pubsub
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2017-03-29 |
| First published | 2017-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jianfei |
| Maintainers | jianfei |
| Keywords | electron, pubsub |

## Links

- npm: https://www.npmjs.com/package/electron-pubsub
- Repository: https://github.com/jianfei/electron-pubsub
- Issues: https://github.com/jianfei/electron-pubsub/issues
- npm.io page: https://npm.io/package/electron-pubsub

## 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.2.2 (latest) — 2017-03-29
- 0.2.1 — 2017-03-29
- 0.2.0 — 2017-03-28
- 0.1.0-alpha.0 — 2017-03-28
- 0.1.0 — 2017-03-21
- 0.0.4 — 2017-03-21
- 0.0.3 — 2017-03-21
- 0.0.2 — 2017-03-21
- 0.0.1 — 2017-03-20

## README

# electron-pubsub

Pubsub for Electron.

You can use it in main or renderer process.

## Usage

### Initialization

```
npm install --save electron-pubsub

// in main process
const pubsub = require('electron-pubsub');

// in renderer process
const pubsub = require('electron').remote.require('electron-pubsub');
```

### Subscribe

```javascript
pubsub.subscribe('myTopic', (event, ...args) => {
    // do something here.
});

pubsub.once('anotherTopic', someCallback);
```

### Publish

```javascript
// in any process
pubsub.publish('myTopic', 'some arguments');
```

### Unsubscribe

```javascript
// in any process
pubsub.unsubscribe('myTopic', someCallback);
pubsub.unsubscribe('myTopic');

pubsub.clearAllSubscriptions();
```

### Hierarchical addressing

```javascript
pubsub.subscribe('a', myFunc1);
pubsub.subscribe('a.b', myFunc2);
pubsub.subscribe('a.b.c', myFunc3);

pubsub.unsubscribe('a.b');
```

### Use promises

```javascript
pubsub.publish('myTopic', 'some arguments')
    .then(onSuccess)
    .catch(onFailure);

pubsub.subscribe('myTopic', (event, ...args) => {
    event.resolve('success!');
});
```

## TODO

- Support hierarchy of topics.

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