Movatterモバイル変換

lifenautjoe/noelPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star166

A universal, human-centric, replayable javascript event emitter.

lifenautjoe.github.io/noel/

License

MIT license

166 stars 2 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 139 Commits
docs		docs
src		src
test		test
tools		tools
website		website
.editorconfig		.editorconfig
.gitignore		.gitignore
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
code-of-conduct.md		code-of-conduct.md
noel-logo.png		noel-logo.png
package-lock.json		package-lock.json
package.json		package.json
rollup.config.ts		rollup.config.ts
tsconfig.json		tsconfig.json
tslint.json		tslint.json

Repository files navigation

A universal, human-centric, replayable event emitter.

Motivation

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 eventconstuser=sessionService.getUser();if(user)updateAvatarPhoto(user)// Listen for further changessessionService.listenUserChanged(updateAvatarPhoto);

can become

sessionService.listenUserChanged(doSomethingWithUser).replay();

Meaning that if theuserChanged event was already fired, it will be replayed with the last arguments and if it gets fired again, we'll be listening.

Features

Event replaying. Never miss a beat.
API designed for humans. No useless concepts to try to make sense of.

Installation

npm install noel

Usage

Creating a noel instance

constNoel=require('Noel');constnoel=newNoel();

Emitting and listening to events

// Listen for an eventnoel.on('friday',partyAllNightLong);// Emit an eventnoel.emit('friday',arg1,arg2 ....);

Replaying events

// Replay an event oncenoel.on(eventName,eventListener).replay();// Replay an event x amount of timesnoel.on(eventName,eventListener).replay(x);

Disabling replay

// When creating the noel instanceconstnoel=newNoel({replay:false});// At runtimenoel.disableReplay(anotherBufferSize);

Enabling replay

Please do note thatreplay is enabled by default, so this should only be necessary if it was disabled at runtime.

// At runtimenoel.enableReplay(anotherBufferSize);

Removing an event listener

noel.removeListener(eventName,eventListener);

or if you save a reference to theeventManager

consteventManager=noel.on('myEvent',eventListener);// ...eventManager.remove();

Removing all event listeners

noel.removeAllListeners(eventName,eventListener);

Clearing an event replay buffer

If you would like to clear all savedevent emissions for replay

noel.clearReplayBufferForEvent(eventName);

Clearing all events replay buffers

If you would like to clear all savedevents emissions for replay

noel.clearEventsReplayBuffers();

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 instanceconstnoel=newNoel({replayBufferSize:aNewBufferSize});// ...// At runtimenoel.setReplayBufferSize(anotherBufferSize);

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 instanceconstnoel=newNoel({noEventListenersWarning:false});// ...// At runtimenoel.disableNoEventListenersWarning();

Enabling the no event listeners warning

Please do note that theno event listeners warning is enabled by default, so this should only be necessary if it was disabled at runtime.

noel.enableNoEventListenersWarning();

Development

Clone the repository

git clone git@github.com:lifenautjoe/noel.git

Use npm commands

npm t: Run test suite
npm start: Runsnpm run build in watch mode
npm run test:watch: Run test suite ininteractive 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 😉)