https://github.com/mvasilkov/cwb
Cross-Window Broadcasting and Locking
https://github.com/mvasilkov/cwb
cross-tab-communication localstorage locking mutex mutex-lock mutex-synchronisation typescript
Last synced: 2 months ago
JSON representation
Cross-Window Broadcasting and Locking
- Host: GitHub
- URL: https://github.com/mvasilkov/cwb
- Owner: mvasilkov
- License: mit
- Created: 2019-04-11T14:01:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-21T08:55:47.000Z (over 5 years ago)
- Last Synced: 2025-04-16T00:13:44.438Z (2 months ago)
- Topics: cross-tab-communication, localstorage, locking, mutex, mutex-lock, mutex-synchronisation, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/cwb
- Size: 157 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
cwb: Cross-Window Broadcasting
===
**cwb** (pronounced *wub*) is a JavaScript library for cross-window
broadcasting and locking.
[![npm][npm-badge]][npm-url]
[![dependencies][dependencies-badge]][dependencies-url]
---
Installation
---
```sh
npm add cwb
```
Usage
---
### Communicating between tabs
#### Subscribe to events
```javascript
import { Channel } from 'cwb'
const chan = new Channel('foo')
chan.on('bar', b => console.log('Got bar:', b))
```
#### Publish events
```javascript
/* In another tab */
const chan = new Channel('foo')
chan.send('bar', 'Porter and Sons')
```
#### Send to the same tab
```javascript
chan.send('bar', 'Porter and Sons', { toSelf: true })
```
### Locking (synchronization)
```javascript
import { lock } from 'cwb'
lock('foo', () => {
/* Critical section. This function can be async. */
})
```
Changelog
---
**1.0.0**
Migrate to TypeScript
**0.0.3**
New method: `Channel#dispose`
**0.0.2**
New method: `Channel#update`
License
---
MIT
The ObjectId type (a vendored dependency) comes from [bson][bson],
which is licensed under the Apache License 2.0
[npm-badge]: https://img.shields.io/npm/v/cwb.svg?style=flat
[npm-url]: https://www.npmjs.com/package/cwb
[dependencies-badge]: https://img.shields.io/david/mvasilkov/cwb?style=flat
[dependencies-url]: https://www.npmjs.com/package/cwb?activeTab=dependencies
[bson]: https://www.npmjs.com/package/bson