can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - can-stream</title> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <link rel="stylesheet" type="text/css" href="./static/bundles/bit-docs-site/static.css"> <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="/docs/images/canjs_favicon.ico"> <link rel="apple-touch-icon" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon-precomposed" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon" sizes="72x72" href="../docs/images/canjs_favicon_72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="../docs/images/canjs_favicon_114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="../docs/images/canjs_favicon_128x128.png"> <link rel="apple-touch-icon" sizes="144x144" href="../docs/images/canjs_favicon_144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="../docs/images/canjs_favicon_152x152.png"> <meta content="yes" name="apple-mobile-web-app-capable"> <meta name="apple-mobile-web-app-status-bar-style" content="white-translucent"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-2302003-11', 'auto'); ga('send', 'pageview'); </script> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger"/> <label for="nav-trigger">Menu</label> <div id="everything"> <div id="left" class="column"> <div class="top-left"> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> <div class="dropdown project-dropdown"> <a href="https://donejs.com/">DoneJS</a> <a href="http://stealjs.com/">StealJS</a> <a href="http://jquerypp.com/">jQuery ++</a> <a href="https://funcunit.com/">FuncUnit</a> <a href="http://documentjs.com/">DocumentJS</a> </div> </div> <div class="version"> <div class="version-number"> 3.0.0 </div> <div class="dropdown version-dropdown"> <a href="https://v2.canjs.com">2.3.27</a> </div> </div> </div> <div class="search-bar"> <p>   </p> </div> </div> <div class="bottom-left"> <div class="social-side-container"> <ul class="social-side"> <li> <a class="header-mobile github" href="https://github.com/canjs/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/github.png">Github</a> </li> <li> <a class="header-mobile twitter" href="https://twitter.com/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/twitter.png">Twitter</a> </li> </ul> <ul class="social-side"> <li> <a class="header-mobile" href="https://gitter.im/canjs/canjs" target="_blank">Chat</a> </li> <li> <a class="header-mobile" href="http://forums.donejs.com/c/canjs" target="_blank">Forum</a> </li> </ul> </div> <ul> <li class=" "> <a class="page" href="guides.html" title="Welcome to CanJS! These guides are here to help you develop and improve your relationship with CanJS. After all, picking a JavaScript framework is a commitment. We want CanJS to be the framework you marry. This page helps you know how advance through the different stages of this relationship:"> Guides </a> </li> <li class=" "> <a class="page" href="can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> </li> <li class=" parent expanded"> <a class="page" href="can-ecosystem.html" title="Useful libraries that extend or add important features to the core collection."> Ecosystem </a> <ul> <li class=" "> <a class="module" href="can-construct-super.html" title="can.Construct.super is a plugin that makes it easier to call base functions from inside inheriting functions."> can-construct-super </a> </li> <li class=" "> <a class="module" href="can-define-stream.html" title="Define property values using streams. can-stream is used internally to provide the stream functionality."> can-define-stream </a> </li> <li class=" "> <a class="module" href="can-fixture.html" title="can-fixture intercepts an AJAX request and simulates the response with a file or function."> can-fixture </a> </li> <li class=" "> <a class="module" href="can-fixture-socket.html" title="Simulate socket.io services."> can-fixture-socket </a> </li> <li class=" "> <a class="module" href="can-jquery.html" title="Extensions to the event system so that can events and jQuery events are cross-bound. Importing can-jquery will return the jQuery object and wire up the event system. var $ = require("can-jquery"); var div = $("<div>"); div.on("inserted", function(){ // it inserted! }); $("body").append(div);"> can-jquery </a> </li> <li class=" "> <a class="module" href="can-stache-converters.html" title="Provides a set of converters useful for two-way binding with form elements such as <input> and <select>."> can-stache-converters </a> </li> <li class="current parent expanded"> <a class="module" href="can-stream.html" title="Convert observable values into streams. Kefir is used internally to provide the stream functionality."> can-stream </a> <ul> <li> <span>Methods</span> <ul> <li class=" "> <a class="function" href="can-stream.toStream.html" title="Provides a shorthand for creating a stream from observable objects, properties and events."> toStream </a> </li> <li class=" "> <a class="function" href="can-stream.toStreamFromCompute.html" title="Creates a stream from can-compute instance which gets updated whenever the compute changes."> toStreamFromCompute </a> </li> <li class=" "> <a class="function" href="can-stream.toStreamFromEvent.html" title="Creates a stream on a {Observable} object that gets updated whenever the event occurs on the observable object."> toStreamFromEvent </a> </li> <li class=" "> <a class="function" href="can-stream.toStreamFromProperty.html" title="Creates a stream on a {Observable} object that gets updated whenever the property value on the observable changes."> toStreamFromProperty </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="can-vdom.html" title="A browser-lite environment for Node.js or a worker thread."> can-vdom </a> </li> <li class=" "> <a class="module" href="can-view-import.html" title=""> can-view-import </a> </li> <li class=" "> <a class="module" href="can-zone.html" title=""> can-zone </a> </li> <li class=" "> <a class="module" href="steal-stache.html" title="A StealJS extension that allows stache templates as dependencies."> steal-stache </a> </li> </ul> </li> <li class=" "> <a class="page" href="can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> </li> <li class=" "> <a class="page" href="can-legacy.html" title="Former libraries that we still accept patches for, but are not under active development."> Legacy </a> </li> </ul> </div> </div> <div id="right" class="column"> <div class="top-right"> <div class="top-right-top"> <ul class="top-right-bitovi"> <li class="dropdown"> <a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a> <ul class="dropdown-menu"> <li><a href="http://bitovi.com">Bitovi.com</a></li> <li><a href="http://bitovi.com/blog/">Blog</a></li> <li><a href="http://bitovi.com/consulting/">Consulting</a></li> <li><a href="http://bitovi.com/training/">Training</a></li> <li><a href="http://bitovi.com/open-source/">Open Source</a></li> </ul> </li> </ul> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> </div> </div> <ul class="top-right-links"> <li> <a href="https://gitter.im/canjs/canjs">Chat</a> </li> <li> <a href="http://forums.donejs.com/c/canjs">Forum</a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/canjs" data-count-href="/canjs/canjs/stargazers" data-count-api="/repos/canjs/canjs#stargazers_count">Star</a> </li> <li> <a href="https://twitter.com/canjs" class="twitter-follow-button nav-social" data-show-count="true" data-show-screen-name="false">Follow @canjs</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </li> </ul> </div> <div class="breadcrumb"> <li><a href="../index.html">CanJS</a></li> / <li><a href="can-ecosystem.html">Ecosystem</a></li> / <li><a href="can-stream.html">can-stream</a></li> <li class="breadcrumb-dropdown">/ <a> On this page</a> <ul class="on-this-page"></ul> </li> <div class="nav-toggle" title="Back to top"></div> </div> </div> <div class="bottom-right"> <article> <section class="title"> <div class="page-type"> <h1>can-stream</h1> <div>module</div> </div> <section class="description"> <p>Convert observable values into streams. <a href="https://rpominov.github.io/kefir/">Kefir</a> is used internally to provide the stream functionality.</p> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-social"> <li> <a class="npm-button" href="https://www.npmjs.com/package/can-stream"> <img src="https://img.shields.io/badge/npm%20package-0.0.4-brightgreen.svg" alt="npm package badge" /> </a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/can-stream" data-count-href="/canjs/can-stream/stargazers" data-count-api="/repos/canjs/can-stream#stargazers_count">Star</a> </li> </ul> <ul class="title-links">  <li><a href="//github.com/canjs/can-stream/tree/v0.0.4/node_modules/can-define-stream/docs/can-stream.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>Object</code> </h2> <p>The <code>can-stream</code> module exports methods useful for converting observable values like <a href="can-compute.html" title="Create an observable value.">can-compute</a>s or <a href="can-define/map/map.html" title="Create observable objects.">can-define/map/map</a> properties into streams.</p> <pre><code class="language-js">var canStream = require("can-stream"); var DefineMap = require("can-define/map/map"); var me = new DefineMap({name: "Justin"}); var nameStream = canStream.toStream(me,".name"); nameStream.onValue(function(name){ // name -> "Obaid"; }); me.name = "Obaid"; </code></pre> </div> <section class="body"> <h2>Usage</h2> <p>The <a href="can-stream.toStream.html" title="Provides a shorthand for creating a stream from observable objects, properties and events.">toStream</a> method has shorthands for all of the other methods:</p> <pre><code>var canStream = require("can-stream"); canStream.toStream(compute) //-> stream canStream.toStream(map, "eventName") //-> stream canStream.toStream(map, ".propName") //-> stream canStream.toStream(map, ".propName eventName") //-> stream </code></pre> <p>For example:</p> <p><strong>Converting a compute to a stream</strong></p> <pre><code class="language-js">var canCompute = require("can-compute"); var canStream = require("can-stream"); var compute = canCompute(0); var stream = canStream.toStream(compute); stream.onValue(function(newVal){ console.log(newVal); }); compute(1); //-> console.logs 1 </code></pre> <p><strong>Converting an event to a stream</strong></p> <pre><code class="language-js">var DefineList = require('can-define/list/list'); var canStream = require('can-stream'); var hobbies = new DefineList(["js","kayaking"]); var changeCount = canStream.toStream(obs, "length").scan(function(prev){ return prev + 1; }, 0); changeCount.onValue(function(event) { console.log(event); }); hobbies.push("bball") //-> console.logs {type: "add", args: [2,["bball"]]} hobbies.shift() //-> console.logs {type: "remove", args: [0,["js"]]} </code></pre> <p><strong>Converting a property value to a stream</strong></p> <pre><code class="language-js">var canStream = require('can-stream'); var DefineMap = require("can-define/map/map"); var person = new DefineMap({ first: "Justin", last: "Meyer" }); var first = canStream.toStream(person, '.first'), last = canStream.toStream(person, '.last'); var fullName = Kefir.combine(first, last, function(first, last){ return first + last; }); fullName.onValue(function(newVal){ console.log(newVal); }); map.first = "Payal" //-> console.logs "Payal Meyer" </code></pre> <p><strong>Converting an event on a nested object into a stream</strong></p> <pre><code class="language-js">var canStream = require('can-stream'); var DefineMap = require("can-define/map/map"); var DefineList = require("can-define/list/list"); var me = new DefineMap({ todos: ["mow lawn"] }); var addStream = canStream.toStream(me, ".todos add"); addStream.onValue(function(event){ console.log(event); }); map.todos.push("do dishes"); //-> console.logs {type: "add", args: [1,["do dishes"]]} </code></pre> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-define-stream/node_modules/can-stream/docs/can-stream.md"},"description":"Convert observable values into streams. [Kefir](https://rpominov.github.io/kefir/) is used internally to provide the stream functionality. \n","type":"module","title":"can-stream","types":[{"type":"Object","options":[],"description":"\n\n The `can-stream` module exports methods useful for converting observable values like [can-compute]s\n or [can-define/map/map] properties into streams.\n\n ```js\n var canStream = require(\"can-stream\");\n var DefineMap = require(\"can-define/map/map\");\n\n var me = new DefineMap({name: \"Justin\"});\n\n var nameStream = canStream.toStream(me,\".name\");\n\n\n nameStream.onValue(function(name){\n\t // name -> \"Obaid\";\n });\n\n me.name = \"Obaid\";\n ```\n"}],"name":"can-stream","parent":"can-ecosystem","package":{"_args":[[{"raw":"can-stream@^0.0.4","scope":null,"escapedName":"can-stream","name":"can-stream","rawSpec":"^0.0.4","spec":">=0.0.4 <0.0.5","type":"range"},"/Users/kevin/dev/canjs/node_modules/can-define-stream"]],"_from":"can-stream@>=0.0.4 <0.0.5","_id":"can-stream@0.0.4","_inCache":true,"_location":"/can-define-stream/can-stream","_nodeVersion":"5.10.1","_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/can-stream-0.0.4.tgz_1477353812523_0.8894528346136212"},"_npmUser":{"name":"justinbmeyer","email":"justin@bitovi.com"},"_npmVersion":"3.8.3","_phantomChildren":{},"_requested":{"raw":"can-stream@^0.0.4","scope":null,"escapedName":"can-stream","name":"can-stream","rawSpec":"^0.0.4","spec":">=0.0.4 <0.0.5","type":"range"},"_requiredBy":["/can-define-stream"],"_resolved":"https://registry.npmjs.org/can-stream/-/can-stream-0.0.4.tgz","_shasum":"c54d8a79b4701e884aa4fedf31e56dd22d912d96","_shrinkwrap":null,"_spec":"can-stream@^0.0.4","_where":"/Users/kevin/dev/canjs/node_modules/can-define-stream","author":{"name":"Bitovi","email":"contact@bitovi.com","url":"http://bitovi.com"},"bit-docs":{"dependencies":{"bit-docs-glob-finder":"^0.0.5","bit-docs-dev":"^0.0.3","bit-docs-js":"^0.0.3","bit-docs-generate-readme":"^0.0.8"},"glob":{"pattern":"**/*.{js,md}","ignore":"node_modules/**/*"},"readme":{"apis":["can-stream"]},"parent":"can-stream"},"bugs":{"url":"https://github.com/canjs/can-stream/issues"},"dependencies":{"can-compute":"^3.0.0","can-define":"^1.0.0","can-event":"^3.0.0","can-observation":"^3.0.0","can-util":"^3.0.0","kefir":"^3.5.1"},"description":"Stream values into and out of computes","devDependencies":{"bit-docs":"0.0.6","done-serve":"^0.2.4","donejs-cli":"^0.9.5","generator-donejs":"^0.9.0","jshint":"^2.9.1","steal":"^0.16.35","steal-qunit":"^0.1.1","steal-tools":"^0.16.0","testee":"^0.2.4"},"directories":{},"dist":{"shasum":"c54d8a79b4701e884aa4fedf31e56dd22d912d96","tarball":"https://registry.npmjs.org/can-stream/-/can-stream-0.0.4.tgz"},"gitHead":"dc5eb397a54144d9af290deb8ab2811b4b8b9abc","homepage":"http://canjs.com","keywords":["canjs","canjs-plugin","donejs"],"main":"can-stream","maintainers":[{"name":"justinbmeyer","email":"justin@bitovi.com"},{"name":"obaidott","email":"obaid@bitovi.com"}],"name":"can-stream","optionalDependencies":{},"readme":"ERROR: No README data found!","repository":{"type":"git","url":"git://github.com/canjs/can-stream.git"},"scripts":{"build":"node build.js","develop":"done-serve --static --develop --port 8080","document":"bit-docs","jshint":"jshint *.js --config","postversion":"git push --tags && git checkout master && git branch -D release && git push","preversion":"npm test && npm run build","release:major":"npm version major && npm publish","release:minor":"npm version minor && npm publish","release:patch":"npm version patch && npm publish","release:pre":"npm version prerelease && npm publish","test":"npm run jshint && npm run testee","testee":"testee test.html --browsers firefox","version":"git commit -am \"Update dist for release\" && git checkout -b release && git add -f dist/"},"system":{"configDependencies":["live-reload"],"npmAlgorithm":"flat"},"version":"0.0.4"},"comment":" ","pathToRoot":".."}; </script> </article> <footer><p>CanJS is part of <a href="http://donejs.com" target="_blank">DoneJS</a>. Created and maintained by the core <a href="https://donejs.com/About.html#section=section_Team" target="_blank">DoneJS team</a> and <a href="http://bitovi.com" target="_blank">Bitovi</a>. <strong>Currently 3.0.0.</strong></p></footer> </div> </div> </div> <script> steal = { instantiated: { "bundles/bit-docs-site/static.css!$css" : null } }; </script> <script type='text/javascript' data-main="bit-docs-site/static" src="./static/node_modules/steal/steal.production.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> </body> </html>