Giter Club home page Giter Club logo

stateful-event's Introduction

a tiny stateful eventbus in few lines of js

Build Status

Usage

var se = require('stateful-event')

var bus   = new se()
bus.debug = true                                      // will output publish() calls in console

var x = bus.subscribe("someprocess/start", function(data, state){
  if( state == "offline" ) return
  // do stuff 
})

bus.subscribe("state", function(state){
  if( state == "online"  ) console.log("fooooo!")
  if( state == "cleanup" ) bus.unsubscribe(x)
})

bus.state("online")                                   // sets state to online 
bus.publish("someprocess/start",{foo:"bar"})          // will fire doFoo()
bus.state("offline")                                  // set state to online
bus.publish("someprocess/start",{foo:"bar"})          // won't fire doFoo
bus.publish("someprocess/start",{foo:"bar"},"online") // set state to "online", and will fire doFoo
bus.publish("someprocess/start",{foo:"bar"})          // will fire doFoo()
console.log( bus.state() )                            // will return "online"
bus.state("cleanup")                                  // will trigger bus.unsubscribe(x)

hint: for (arguably) more pretty code, you could use string-variables named like ONLINE instead of "online"

Features

  • event listening and triggering
  • be able to unsubscribe or ignore events in certain state
  • easier to use / extendable compared to EventEmitter
  • maintain state in bus instead of global scope

Functions

bus.state(state)                  // set/get state: state("mystate") or state() returns current state-string
bus.publish(channel, data, state) // publish: publish('some/channel', ['Denis', 'Ciccale'], "mystate" // optional )
bus.subscribe(channel, handler)   // usage: var handle = subscribe('some/channel', function (name, lastName) {})
bus.unsubscribe(handle)           // usage: unsubscribe(handle);

stateful-event's People

Contributors

coderofsalvation avatar

Watchers

 avatar  avatar

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.