Handles events, on a pub-sub design pattern basis
npm install @xtitusx/event-bus[npm-url]: https://www.npmjs.com/package/@xtitusx/event-bus
[npm-image]: https://img.shields.io/npm/v/@xtitusx/event-bus
[ci-image]: https://img.shields.io/travis/com/xtitusx/event-bus
[codecov-url]: https://codecov.io/gh/xtitusx/event-bus
[codecov-image]: https://codecov.io/gh/xtitusx/event-bus/branch/master/graph/badge.svg?token=6WEWL2D8DB
[snyk-security-image]: https://snyk-widget.herokuapp.com/badge/npm/%40xtitusx%2Fevent-bus/badge.svg
[snyk-url]: https://snyk.io/test/github/xtitusx/event-bus/badge.svg
[snyk-image]: https://snyk.io/test/github/xtitusx/event-bus
[downloads-image]: https://img.shields.io/npm/dm/@xtitusx/event-bus
[min-size-image]: https://img.shields.io/bundlephobia/min/@xtitusx/event-bus
npm install @xtitusx/event-bus
`
Basic Usage
- Inherit a subclass from Event abstract class:
`
export class HelloWorldEvent extends Event {}
`
- Declare a custom type message:
`
export type HelloWorldMessage = { name?: string };
`
- Inherit a subclass from Subscriber abstract class:
`
export class HelloWorldEventSubscriber extends Subscriber {
constructor() {
super();
}
/**
* @override
*/
public implCallback(): Function {
return async (message: HelloWorldMessage): Promise => {
console.log( Hello ${message?.name ?? 'World'}!);
};
}
}
`
- Then you can play around with an EventBus instance:
`
const eventBus = new EventBus();
eventBus.subscribe(HelloWorldEvent, new HelloWorldEventSubscriber());
eventBus.publish(HelloWorldEvent);
// => 'Hello World!'
`
$3
Although the singleton is considered to be an anti pattern as it's introducing global states, it can be useful in some use cases, like a lack of dependency injection:
`
EventBus.getInstance().subscribe(HelloWorldEvent, new HelloWorldEventSubscriber());
EventBus.getInstance().publish(HelloWorldEvent);
// => 'Hello World!'
`
EventBus
$3
Adds a subscriber for the specified event. No checks are made to see if the subscriber has already been added.
Multiple calls passing the same combination of event and subscriber will result in the subscriber being added multiple times:
`
const eventBus = new EventBus();
eventBus.subscribe(HelloWorldEvent, new HelloWorldEventSubscriber());
eventBus.publish(HelloWorldEvent);
// => 'Hello World!'
eventBus.publish(HelloWorldEvent, {
name: 'Benjamin',
});
// => 'Hello Benjamin!'
`
$3
Adds a one time subscriber to the event. This subscriber is invoked only the next time the event is fired, after which it is removed:
`
const eventBus = new EventBus();
eventBus.once(HelloWorldEvent, new HelloWorldEventSubscriber());
eventBus.publish(HelloWorldEvent, {
name: 'Chorizo',
});
// => 'Hello Chorizo!'
eventBus.publish(HelloWorldEvent, {
name: 'Chorizo',
});
// => Nothing
`
$3
- Removes all subscribers:
`
const eventBus = new EventBus();
eventBus.subscribe(HelloWorldEvent, new HelloWorldEventSubscriber());
eventBus.publish(HelloWorldEvent, {
name: 'Benjamin',
});
// => 'Hello Benjamin!'
eventBus.clear();
eventBus.publish(HelloWorldEvent, {
name: 'Benjamin',
});
// => Nothing
`
- Or removes only subscribers for the specified event:
`
const eventBus = new EventBus();
eventBus.subscribe(HelloWorldEvent, new HelloWorldEventSubscriber());
eventBus.publish(HelloWorldEvent, {
name: 'Benjamin',
});
// => 'Hello Benjamin!'
eventBus.clear(HelloWorldEvent);
eventBus.publish(HelloWorldEvent, {
name: 'Benjamin',
});
// => Nothing
`
Subscription
$3
Removes the subscriber for the specified event:
`
const eventBus = new EventBus();
const subscription = eventBus.subscribe(HelloWorldEvent, new HelloWorldEventSubscriber());
eventBus.publish(HelloWorldEvent);
// => 'Hello World!'
subscription.unsubscribe();
eventBus.publish(HelloWorldEvent, {
name: 'Chorizo',
});
// => Nothing
`
TypeDoc
GitHub HTML Preview
Changelog
See information about breaking changes and release notes here.
Maintainer
- xtitusx - Benjamin Tussac (author)
License
`
MIT License
Copyright (c) 2021 Benjamin Tussac
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
``