emits-change

1.0.1 • Public • Published

emits-change

Software License Build Status

Plug-and-play node.js events integration to emit change events.

Installation

npm install emits-change

This package uses the node.js events API. Make sure your javascript bundler can handles importing core node modules (e.g. Browserify does this).

Usage

Calling emitsChange on an object will add node's EventEmitter, a listen, an unlisten and an emitChange function to the prototype.

import emitsChange from 'emits-change'
 
class Emitter {
    constructor() {
        emitsChange(this)
    }
}
 
let emitter = new Emitter
 
function doSomethingOnChange() {
    console.log('hodor')
}
 
emitter.listen(doSomethingOnChange)
 
emitter.emitChange()
// => hodor
 
emitter.unlisten(doSomethingOnChane)
 
emitter.emitChange()
// => *nothing*

Testing

You can run the tests (ESLint & Mocha) with:

npm run test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Credits

About Spatie

Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

License

The MIT License (MIT). Please see License File for more information.

Package Sidebar

Install

npm i emits-change

Weekly Downloads

0

Version

1.0.1

License

MIT

Last publish

Collaborators

  • sebastiandedeyne