backbone-esnext-eventbus
v0.3.1
Published
Provides a default main eventbus instance for backbone-esnext-events.
Downloads
5
Maintainers
Readme
Provides a default instance of backbone-esnext-events which may serve as a main eventbus. Please refer to backbone-esnext-events for detailed documentation. The main impetus for a default main eventbus being easily imported across modules is to facilitate message passing between modules versus direct dependencies / method invocation.
It should be noted that this module only depends on backbone-esnext-events which has no other dependencies.
An example follows:
import mainEventbus from 'backbone-esnext-eventbus';
mainEventbus.on('fire:test', () => { console.log('Test Fired!'); return 42; }
mainEventbus.trigger('fire:test'); // Prints 'Test Fired'!
const value = mainEventbus.triggerSync('fire:test'); // Prints 'Test Fired' and returns '42'!
assert(value === 42);
and in an entirely separate module / source file:
import mainEventbus from 'backbone-esnext-eventbus';
const value = mainEventbus.triggerSync('fire:test'); // Prints 'Test Fired' and returns '42'!
assert(value === 42);
There are also two other alternate eventbus instances provided as named exports: auxEventbus
and pluginEventbus
.
These can be imported as follows:
import { auxEventbus } from 'backbone-esnext-eventbus';
import { pluginEventbus } from 'backbone-esnext-eventbus';