Giter Site home page Giter Site logo

gmaiolo / subscribr Goto Github PK

View Code? Open in Web Editor NEW
10.0 4.0 1.0 37 KB

A tiny event subscriber.

Home Page: https://npm.im/subscribr

License: MIT License

JavaScript 100.00%
js js-api js-library js-libs library event-management api event-handlers pubsub pub-sub

subscribr's Introduction

npm downloads travis dependencies dev dependencies

API

Subscribr.on(eventId, handler)

Subscribe to an event.

Parameters

Name Type Description
eventId string the event ID.
handler function the callback function.

Returns

  • function Subscription destroyer.

Subscribr.one(eventId, handler)

Subcribe an evento to be executed only once (gets self-destroyed after execution).

Parameters

Name Type Description
eventId string the event ID.
handler function the callback function.

Returns

  • function Subscription destroyer.

Subscribr.emit(eventId, params)

Emit an event.

Parameters

Name Type Description
eventId string the event ID.
params object handler params.

Subscribr.listHandlers(eventId)

List an event's handlers.

Parameters

Name Type Description
eventId string the event ID.

Returns

  • array Event handlers.

Subscribr.remove(eventId)

Unsubscribe an event.

Parameters

Name Type Description
eventId string the event ID.

Subscribr.interceptors

Get interceptors.

Returns

  • array Interceptors.

Subscribr.events

Get events.

Returns

  • array Events.

Subscribr.all

Get all events and interceptors.

Returns

  • object Events.

subscribr's People

Contributors

asainz avatar gmaiolo avatar tucker-eric avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

asainz

subscribr's Issues

Finish unit tests

Coverage is pretty low as I haven't had time to complete the unit tests.

Create directories and transpile

src directory for ES6 code
libdirectory for babel output
test directory for tests

And accommodate existing scripts & package.json accordingly.

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.