GitHub
Twittercan-kefir
Integrate KefirJS streams directly within can-stache and other parts of CanJS.
Object
can-kefir exposes value and error key values on a stream that can be read and listened to
by can-reflect and therefore many other CanJS libraries like can-stache and can-stache-bindings.
The can-kefir module imports KefirJS and mutates it in two ways:
First, it adds symbols to Kefir's types so Kefir streams can be read and listened to for changes by can-reflect. This allows integration with various parts of CanJS like can-stache and can-stache-bindings.
Second, it adds a emitterProperty method that creates a stream that is more easily writable.
The decorated Kefir object is exported by the can-kefir module.
Use
To use it with can-stache, create a stream and use .value or .error to write out the
last emitted value or error.
The following will show a number increasing to 3 over 3 seconds:
import Kefir from "can-kefir";
const countTo3Stream = Kefir.sequentially( 1000, [ 1, 2, 3 ] );
const view = stache( "<p>Number: {{countTo3Stream.value}}</p>" );
const frag = view( {
countTo3Stream: countTo3Stream
} );
document.body.appendChild( frag );
emitterProperty
Use emitterProperty to create an stream object that also
has an emitter-like object attached. The following creates an age stream that we can emit events on with its emitter.value() method:
import Kefir from "can-kefir";
const age = Kefir.emitterProperty();
age.onValue( function( age ) {
console.log( age );
} );
age.emitter.value( 20 ); //-> logs 20
age.emitter.value( 30 ); //-> logs 30