An open API service indexing awesome lists of open source software.

https://github.com/tiaanduplessis/xpel

♻️ Tiny single function event-emitter/pubsub
https://github.com/tiaanduplessis/xpel

event-emitter pubsub

Last synced: 11 months ago
JSON representation

♻️ Tiny single function event-emitter/pubsub

Awesome Lists containing this project

README

          





Tiny single function event-emitter/pubsub



npm package version


npm downloads


standard JS linter


prettier code formatting


travis ci build status


project license


make a pull request






Github Watch Badge


Github Star Badge


Tweet





Built with ❤︎ by tiaanduplessis and contributors

Table of Contents

Table of Contents

  • Install

  • Usage

  • Contribute

  • License
  • ## Install

    ```sh
    $ npm install xpel
    # OR
    $ yarn add xpel
    ```

    ## Usage

    ```js
    const xpel = require('xpel')

    const emitter = xpel()

    emitter('foo', data => console.log('foo:', data))
    const unsubBar = emitter('bar', data => console.log('bar:', data))
    emitter('bar', data => console.log('bar2:', data))
    const unsubFoo = emitter('foo', data => console.log('foo2:', data))

    // listen to all events
    emitter('*', () => console.log('Things are happening!'))

    // Emit
    emitter('foo', 5)

    // unsub foo
    unsubFoo('foo')

    emitter('foo', 'nothing emitted')
    emitter('bar', 5)

    // unsub bar
    unsubBar('bar')

    emitter('bar', 'baz')
    emitter('foo', 'baz')

    // foo: 5
    // foo2: 5
    // Things are happening!
    // Things are happening!
    /// bar: 5
    // bar2: 5
    // Things are happening!
    // Things are happening!
    // Things are happening!

    ```

    ## Contributing

    Contributions are welcome!

    1. Fork it.
    2. Create your feature branch: `git checkout -b my-new-feature`
    3. Commit your changes: `git commit -am 'Add some feature'`
    4. Push to the branch: `git push origin my-new-feature`
    5. Submit a pull request :D

    Or open up [a issue](https://github.com/tiaanduplessis/xpel/issues).

    ## License

    Licensed under the MIT License.