@anthonyalbertyn/interval-emitter v0.1.2

interval-emitter

IntervalEmitter can be used in server-side Node projects

MIT License, see LICENSE for more details

Uses case

Emit a specified event at a specified interval. See /examples in this node module for some use cases.

Getting started

npm install @anthonyalbertyn/interval-emitter

Using interval-emitter

const IntervalEmitter = require('@anthonyalbertyn/interval-emitter');

// First argument is milliseconds (positive integer, required)
// Second argument is the event name that will be emitted (string, required)
const myIntervalEmitter = new IntervalEmitter(1000, "my-event");

myIntervalEmitter.start();

myIntervalEmitter.on('my-event', () => {
    console.log("Hello");
});

To stop the emitter in your code

myIntervalEmitter.stop();

You can create more than one IntervalEmitter in your code.

Limitations

IntervalEmitter does not emit arguments, just an event

Maintainers

There is currently only one maintainer, Anthony Albertyn, and the plan is to keep this module simple, light-weight and not add more features unless there are good reasons to do so.