Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mia1024/cross-context-events
https://github.com/mia1024/cross-context-events
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mia1024/cross-context-events
- Owner: mia1024
- Created: 2021-07-23T06:11:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T04:16:55.000Z (10 months ago)
- Last Synced: 2024-12-07T08:22:36.909Z (14 days ago)
- Language: TypeScript
- Size: 2.38 MB
- Stars: 234
- Watchers: 2
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - cross-context-events - Send and receive events across JS execution context. (Uncategorized / Uncategorized)
README
# Cross Context Events
Cross context events is a robust, lightweight package providing the option to
send and receive events across JS execution context.
You asked, what does this mean, exactly? Well, it means that when you emit an
event in your script, the same event will also be emitted in all other linked
execution contexts (i.e. other tabs, windows, processes), even on different
computers if you want to! All you need to do is writing a few lines of code to
link them together.
[Try the demo here](https://mia1024.github.io/cross-context-events/demos/frames-and-windows/)
[Source code for the demo](https://github.com/mia1024/cross-context-events/tree/main/docs/demos/frames-and-windows)
## Documentations
See [here](https://mia1024.github.io/cross-context-events/).
## Features
- Lightweight
- No runtime dependency
-
Comprehensive [documentations](https://mia1024.github.io/cross-context-events/)
- Containerization
- Support for named and anonymous containers to provide isolation if you
need
- Unified interface
- Works the same way whether you are using browser, service worker, node, or
even electron.
- Cross Context
- Capable of sending events across execution context (e.g. from one tab to
another tab in browser or from one process to another process in Node)
with minimal setup, so long as an IPC channel can be established between
the sending context and receiving context.
- Relay support: events can be optionally relayed across the network if you
have one.
- Typescript support
- Written completely in typescript completely with strong type inferences.
- Comprehensive testing
- All core functions are unittested
- Namespaced events and bubbling
- If you emit an event for `event.context.new`, then listeners for
`event.context` and `event` are also notified (but `event.context2` is
not). This behavior can be disabled if desired.
See [event bubbling](events?id=event-bubbling).
- Event relaying
- Even if you have a network of nested iframes like the image below, and you
emit an event in iframe 9 (or any frame or the parent window for that
matter), it will be emitted in all frames and the parent window. This also
applies to a chain or child processes or workers or any other combinations
of communication channels.
See [event relaying](transports?id=event-relaying).
## Installation
Unpkg
```html
```
jsDelivr
```html
```
yarn
```bash
yarn add cross-context-events
```
npm
```bash
npm install cross-context-events
```
## Getting started
This example uses the
[WebWorker API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)
, but it can be easily switched to Node processes, iFrames, or others by simply
changing the transport used. For details, please refer
to [transports](https://mia1024.github.io/cross-context-events/#/transports).
```js
// index.js
import {
useGlobalTransport,
createDefaultTransport,
createEvent
} from "cross-context-events";
const OnlineEvent = createEvent("worker.online")
OnlineEvent.addListener(() => console.log("Worker is now online ＼(＾▽＾)／"))
let worker = new Worker("worker.js")
useGlobalTransport(createDefaultTransport({
type: "worker",
target: worker
}))
```
```js
// worker.js
import {
useGlobalTransport,
createDefaultTransport,
createEvent
} from "cross-context-events";
useGlobalTransport(createDefaultTransport({
type: "worker",
target: self
}))
const OnlineEvent = createEvent("worker.online")
new OnlineEvent().emit()
```
As you can see, `Worker is now online ＼(＾▽＾)／` has been logged to the console
from the main thread. Yay!
Please refer to the
[documentation](https://mia1024.github.io/cross-context-events/#/quickstart)
for more information.