Giter Club home page Giter Club logo

weak-emitter's Introduction

weak-emitter

Contexts based event emitter on ES6 WeakMaps

Build Status npm version

const context = {}
const eventKey = 'propName'
emitter.on(context, eventKey, (...args) => console.log(args))
emitter.emit(context, eventKey, 'first', 2, true)
// ['first', 2, true]

Install

npm i weak-emitter --save
# or: yarn add weak-emitter

Emitter API

Argument types:

  • context: object
  • eventKey: string | object
  • handler: (...args: []) => void

on(context, eventKey, handler)

Create new event with eventKey in context that will trigger the handler. Every handler will be added once, despite the number of times it was added to the event. Handlers are invoked in the order they were added.

Returns an event controller that has three methods:

  • emit(...args): trigger handler
  • off(): remove event
  • tranfer(destination): moves the event to destination context
const context = {}
const eventKey = 'propName'
const evController = emitter.on(context, eventKey, (...args) => doSomething(args))

const ctx2 = {}
evController.transfer(ctx2)
evController.off()

emit(context, eventKey[, ...args])

Invoke all handlers in context tagged with key, passing the rest of the arguments

const context = {}
const eventKey = 'propName'
emitter.on(context, eventKey, (...args) => console.log(args))
emitter.emit(context, eventKey, 'first', 2, true)
// ['first', 2, true]

off(context, key, handler)

Removes handler from the event tagged with key in context

emitter.off(context, eventKey, handler)

Testing

npm test




© 2020 Jacobo Tabernero - Released under MIT License

weak-emitter's People

Contributors

jacoborus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

weak-emitter's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.