DoneJS StealJS jQuery++ FuncUnit DocumentJS
3.14.1
5.0.0 4.3.0 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-compute
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-stream
      • can-define-stream-kefir
      • can-event
      • can-event/async/async
      • can-event/batch/batch
      • can-event/lifecycle/lifecycle
      • can-kefir
        • symbols
          • can.getKeyValue
          • can.offKeyValue
          • can.onKeyValue
          • can.setKeyValue
        • methods
          • emitterProperty
      • can-list
      • can-map
      • can-map-backup
      • can-map-define
      • can-observation
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
    • Data Modeling
      • can-connect
      • can-connect-cloneable
      • can-connect-feathers
      • can-connect-ndjson
      • can-connect-signalr
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-ejs
      • can-element
      • can-react-component
      • can-stache
      • can-stache/helpers/route
      • can-stache-bindings
      • can-stache-converters
      • can-view-autorender
      • can-view-callbacks
      • can-view-href
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-globals
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-control
      • can-dom-events
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-jquery
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-namespace
      • can-reflect
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

can-kefir

  • npm package badge
  • Star
  • Edit on GitHub

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:

var Kefir = require("can-kefir");

var countTo3Stream = Kefir.sequentially(1000,[1,2,3]);

var view = stache("<p>Number: {{countTo3Stream.value}}</p>");

var 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:

var Kefir = require("can-kefir");

var age = Kefir.emitterProperty();

age.onValue(function(age){
  console.log(age)
});

age.emitter.value(20) //-> logs 20

age.emitter.value(30) //-> logs 30

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 3.14.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news