@moreonion/jquery-event-bridge v0.2.3

jQuery event bridge

An event bridget for sharing events between multiple instances of jQuery running on the same site.

Normally if you run multiple jQuery instances they don’t cooperate. When an event is triggered in one instance ($.trigger('change')) the event does not trigger event handlers registered on another instance (other$.on('change', function (event) { /*…*/ })). This package provides a way to forward events from one jQuery instance to another.

Usage

import EventBridge from "jquery-event-bridge"

const bridge = new EventBridge()
bridge.connect(jQuery_one).connect(jQuery_two)

After the code is executed all events triggered in one of the two instances also arrive in the other instance.

Development

Install nodejs and yarn, then install the needed dependencies:

apt install nodejs yarn
yarn install

Use the different yarn scripts for the development workflow:

yarn run lint
yarn run test
yarn run dev

For building a releaseable artifact (library file) use:

yarn run dist

The development files are configured to be created under build/, the releaseable files are created under dist/.

Advanced use

This project uses Parcel for bundling. For options run:

yarn run parcel --help

In order to build the JavaScript without [hash] in the file name, just use the main.js as entrypoint (not the .html file) when building:

yarn run parcel build src/main.js

It has eslint and babel configured for the source and test files. Tests are run via mocha, assertions use Node's assert(). Mocking can be done with sinon.