Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

kefir-bus

Macil27.5kMIT2.3.1TypeScript support: included

Kefir.bus for people who still want it

kefir, kefir.js

readme

kefirBus

GitHub license npm version CircleCI Status Greenkeeper badge

Kefir 3.0 removed Kefir.bus from the core project, so now it's up to 3rd party modules to implement it. This module is an implementation of Kefir.Bus that passes all of Kefir's older tests for Kefir.Bus.

Older code:

var Kefir = require('kefir');
var bus = Kefir.bus();

Now with this module:

var Kefir = require('kefir');
var kefirBus = require('kefir-bus');
var bus = kefirBus();

See Kefir's deprecated API docs for information about Kefir buses.

Most code that uses Buses can be done in a better and more idiomatic way with Kefir. Try to investigate alternatives before you use a bus! Consider the following code:

// BAD CODE EXAMPLE!
var bus = kefirBus();

setInterval(function() {
  bus.emit(null);
}, 1000);

bus.take(5).onValue(function() {
  console.log('beep'); // runs 5 times
});

This code never stops the interval timer! It will continue to emit nulls into the bus for eternity, even though no one is receiving the values. Unsubscribing from a bus can't send any unsubscription notification to to the producer calling the emit method.

Kefir itself has functions that provide streams which automatically stop producing values as soon they are unsubscribed from. The following code does not suffer from the problem of the previous example:

Kefir.interval(1000).take(5).onValue(function() {
  console.log('beep'); // runs 5 times
});

Types

Both TypeScript and Flow type definitions for this module are included! The type definitions won't require any configuration to use.

changelog

2.3.1 (2019-01-29)

  • Updated TypeScript type definitions for compatibility with latest Kefir type definitions.

2.3.0 (2018-09-25)

  • Added TypeScript type definitions.

2.2.1 (2016-09-13)

  • Made Flow type definitions more accurate.

2.2.0 (2016-08-29)

  • Added .value and .event methods to match new Kefir emitter methods.
  • Added Flow type definitions.

2.1.0 (2016-02-25)

  • Bind Bus methods to instance so they may be called directly without a this parameter #4

2.0.0 (2015-10-01)

Breaking Changes

  • Updated peerDependencies to require Kefir v3 #1

1.0.4 (2015-08-04)

  • Fixed exception being thrown if Bus.end() was called during dispatch of end event.

1.0.3 (2015-06-23)

  • Fixed bug caused when bus was subscribed to while it was ending.

1.0.2 (2015-05-07)

  • Don't buffer up events while bus is inactive. Makes kefir-bus better match original Kefir behavior.

1.0.1 (2015-05-04)

  • Minor memory improvement: remove references to listeners on end.

1.0.0 (2015-04-28)

Initial release.