A universal, human-centric, replayable event emitter.
Table of Contents
- Creating a noel instance
- Emitting and listening to events
- Replaying events
- Disabling replay
- Enabling replay
- Removing an event listener
- Removing all event listeners
- Clearing an event replay buffer
- Clearing all events replay buffers
- Changing the events replay buffer size
- Disabling the no event listeners warning
- Enabling the no event listeners warning
The world just like software is full of events. Sometimes these events occur while we are busy doing other things. Wouldn't it be nice to have a way to replay all events? Noel is the way.
By being able to replay events we can design reactive systems without having to worry about timing.
For example, code like
// Check if there is a user in case we missed the userChanged event;ifuser updateAvatarPhotouser// Listen for further changessessionService.listenUserChangedupdateAvatarPhoto;
Meaning that if the
userChanged event was already fired, it will be replayed with the last arguments and if it gets fired again, we'll be listening.
- Event replaying. Never miss a beat.
- API designed for humans. No useless concepts to try to make sense of.
npm install noel
Creating a noel instance
Emitting and listening to events
// Listen for an eventnoel.on'friday', partyAllNightLong;// Emit an eventnoel.emit'friday', arg1, arg2 ....;
// Replay an event oncenoel.oneventName, eventListener.replay;// Replay an event x amount of timesnoel.oneventName, eventListener.replayx;
// When creating the noel instance;// At runtimenoel.disableReplayanotherBufferSize;
Please do note that replay is enabled by default, so this should only be necessary if it was disabled at runtime.
// At runtimenoel.enableReplayanotherBufferSize;
Removing an event listener
or if you save a reference to the
Removing all event listeners
Clearing an event replay buffer
If you would like to clear all saved event emissions for replay
Clearing all events replay buffers
If you would like to clear all saved events emissions for replay
Changing the events replay buffer size
Or in human words, changing the amount of event emissions that are saved for replays.
Default is 1.
// When creating the noel instance;// ...// At runtimenoel.setReplayBufferSizeanotherBufferSize;
Disabling the no event listeners warning
When an event is emitted, no listeners have been set AND the replay was disabled so there is no way of doing anything with the emission, a warning will be logged into the console if available. To disable this behaviour:
// When creating the noel instance;// ...// At runtimenoel.disableNoEventListenersWarning;
Enabling the no event listeners warning
Please do note that the no event listeners warning is enabled by default, so this should only be necessary if it was disabled at runtime.
Clone the repository
git clone email@example.com:lifenautjoe/noel.git
Use npm commands
npm t: Run test suite
npm start: Runs
npm run buildin watch mode
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting and generate coverage
npm run build: Generate bundles and typings, create docs
npm run lint: Lints code
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)
Author Joel Hernandez