A messaging channel for sending data between specific topic listeners. This works between browsing contexts (that is, windows, tabs, frames, or iframes) and workers of the same origin.
npm i hermes --save
yarn add hermes
import hermes from "hermes-channel";
-
send(topic, data, [includeSelf=false])
: Send data to other browser tabs subscribed to a specified topic.topic
: The name of the topic in which the data will be sent to.data
: The data to be sent. This needs to be a JSON-serializable object.includeSelf
(optional, default=false): A boolean indicating whether the data should also be sent to the current tab.
hermes.send("some-topic", "hello world"); hermes.send("some-topic", { title: "awesome" }); hermes.send("some-topic", { title: "awesome" }, true);
-
on(topic, callback)
: Add a callback function for a specified topic.topic
: The name of the topic to subscribe to.callback
: The callback function, which accepts a single argument representing the data that was sent originally.
hermes.on("some-topic", function(data) {});
-
off(topic, [callback])
: Remove a callback function for a specified topic.topic
: The name of the topic to unsubscribe from.callback
(optional): The callback function to remove, or don't provide in order to remove all callback functions for thetopic
topic.
hermes.off("some-topic", callbackFunction); hermes.off("some-topic");