/Qlack2-Bower-pubsub

Primary LanguageJavaScript

QPubSub

A cross-frame pubsub library. QPubSub allows your application to utilise publish/subscribe messaging across different components and layers. What makes this library interesting is that it also allows inter-frame pubsub, that is establishing subscriptions and publishing from different iframes even if these iframes belong to different domains. Such inter-domain message passing is taking place via the well-establish HTML5 Window.postMessage() method.

The library follows a client-server paradigm, where a single-only instance of QPubSub is acting as a Hub (the server) and multiple QPubSub instances are acting as the clients. The server component needs to be started prior to all clients, however clients may perform a fallback-and-wait logic while initiating their connection to the server until the server becomes available (note that such logic is not currently part of the library).

An AngularJS wrapper is also available for this component as QNgPubSub.

Installing

bower install --save qlack2-bower-pubsb

Usage

Starting the server

On the window where the server component runs, initialise QPubSub as:

window.onload = function() {
	QPubSub.init("server", true);
};
  • The first argument is the name of this instance. This name does not have any practical implication other than helping you identifying the source of log messages.
  • The second argument is a boolean value indicating whether this instance of QPubSub is a server instance; obviously, you need to set it as 'true'.

Starting a client

window.onload = function(){
	QPubSub.init("client1"", false);
};
  • Similarly to the server instantiation, but indicating that this is a client instance with the 'false' argument.

During client initialisation, QPubSub will traverse the DOM and try to identify a listening QPubSub server. Once the server is identified, a ping-pong style of message exchange will take place to allow the client to register with the server. You need to ensure that when initialisation of the client takes place the server component is already loaded and initialised.

API

init(name, isServer)

Initialises the QPubSub instance.

  • name A String value identifying the name of this instance. Its only purpose is to identify the source of console logging messages.
  • isServer A Boolean value indicating whether this instance is a server. Make sure you only have one server instance running.

subscribe(topic, callback)

Subscribe to a topic to receive messages. Each message received is forwarded to the callback function specified.

  • topic The name of the topic to subscribe to.
  • callback A callback function to receive the message.

unsubscribe(topic)

Unsubscribes from a previously subscribed topic.

  • topic The name of the topic to unsubscribe from.

publish(topic, message)

Publishes a message to a specific topic.

  • topic The name of the topic where the message will be published.
  • message The message to be published.

setLogActive(boolean)

  • boolean Whether to set loggin as active or not.

Development

Npm Scripts

npm preversion (auto)

It runs npm build.

npm postversion (auto)

It runs bowerSync and changelog.

npm pretest (auto)

It runs build.

npm test (manual)

It launches tests with mocha.

npm postest (auto)

It runs format and lint.

Custom Scripts

They are all run by the previous npm scripts but you can run them at your convenience.

npm run prebuild (manual)

It runs format and lint.

npm run build (manual)

It runs umd and uglify.

npm run lint

Lint with ESLint

npm run umd

It packages the library with umd

npm run uglify

It uglifies the library.