diff --git a/docs/can-define-stream.md b/docs/can-define-stream.md index d057807..c51c69d 100644 --- a/docs/can-define-stream.md +++ b/docs/can-define-stream.md @@ -12,35 +12,35 @@ The `can-define-stream` module exports a function that takes a [can-define-stream.types.streamInterface] and returns a function that takes a [can-define-stream.types.DefineMap DefineMap.prototype] or [can-define-stream.types.DefineList DefineList.prototype] and uses the supplied stream interface to create streamed property definitions. ```js -var canStream = require("can-stream-kefir"); -var canDefineStream = require("can-define-stream"); -var DefineMap = require("can-define/map/map"); - -var Person = DefineMap.extend({ - first: "string", - last: "string", - fullName: { - get: function() { - return this.first + " " + this.last; - } - }, - fullNameChangeCount: { - stream: function() { - return this.toStream(".fullName").scan(function(last) { - return last + 1; - }, 0); - } - } -}); - -canDefineStream(canStream)(Person); - -var me = new Person({name: "Justin", last: "Meyer"}); - -me.on("fullNameChangeCount", function(ev, newVal) { - console.log(newVal); -}); -me.fullNameChangeCount //-> 0 +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; +import DefineMap from "can-define/map/map"; + +const Person = DefineMap.extend( { + first: "string", + last: "string", + fullName: { + get: function() { + return this.first + " " + this.last; + } + }, + fullNameChangeCount: { + stream: function() { + return this.toStream( ".fullName" ).scan( function( last ) { + return last + 1; + }, 0 ); + } + } +} ); + +canDefineStream( canStream )( Person ); + +const me = new Person( { name: "Justin", last: "Meyer" } ); + +me.on( "fullNameChangeCount", function( ev, newVal ) { + console.log( newVal ); +} ); +me.fullNameChangeCount; //-> 0 me.first = "Obaid"; //-> console.logs 1 me.last = "Ahmed"; //-> console.logs 2 ``` @@ -56,9 +56,9 @@ me.last = "Ahmed"; //-> console.logs 2 The [can-define-stream.toStream] method has shorthands for all of the other methods: ```js -toStream("eventName") //-> stream -toStream(".propName") //-> stream -toStream(".propName eventName") //-> stream +toStream( "eventName" ); //-> stream +toStream( ".propName" ); //-> stream +toStream( ".propName eventName" ); //-> stream ``` For example: @@ -66,26 +66,26 @@ For example: __Update map property based on stream value__ ```js -var DefineMap = require('can-define/map/map'); -var canStream = require("can-stream-kefir"); -var canDefineStream = require("can-define-stream"); +import DefineMap from "can-define/map/map"; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; -var Person = DefineMap.extend({ - name: "string", - lastValidName: { - stream: function() { - return this.toStream(".name").filter(function(name) { // using propName - return name.indexOf(" ") >= 0; - }); - } - } -}); +const Person = DefineMap.extend( { + name: "string", + lastValidName: { + stream: function() { + return this.toStream( ".name" ).filter( function( name ) { // using propName + return name.indexOf( " " ) >= 0; + } ); + } + } +} ); -canDefineStream(canStream)(Person); +canDefineStream( canStream )( Person ); -var me = new Person({name: "James"}); +const me = new Person( { name: "James" } ); -me.on("lastValidName", function(lastValid) {}); +me.on( "lastValidName", function( lastValid ) {} ); me.name = "JamesAtherton"; //lastValidName -> undefined me.name = "James Atherton"; //lastValidName -> James Atherton @@ -94,27 +94,27 @@ me.name = "James Atherton"; //lastValidName -> James Atherton __Stream on DefineList__ ```js -var DefineList = require('can-define/list/list'); -var canStream = require("can-stream-kefir"); -var canDefineStream = require("can-define-stream"); +import DefineList from "can-define/list/list"; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; -var PeopleList = DefineList.extend({}); +const PeopleList = DefineList.extend( {} ); -canDefineStream(canStream)(PeopleList); +canDefineStream( canStream )( PeopleList ); -var people = new PeopleList([ - { first: "Justin", last: "Meyer" }, - { first: "Paula", last: "Strozak" } -]); +const people = new PeopleList( [ + { first: "Justin", last: "Meyer" }, + { first: "Paula", last: "Strozak" } +] ); -var stream = people.toStream('length'); // using eventName +const stream = people.toStream( "length" ); // using eventName -stream.onValue(function(val) { - val //-> 2, 3 -}); +stream.onValue( function( val ) { + val; //-> 2, 3 +} ); -people.push({ - first: 'Obaid', - last: 'Ahmed' -}); //-> stream.onValue -> 3 +people.push( { + first: "Obaid", + last: "Ahmed" +} ); //-> stream.onValue -> 3 ``` diff --git a/docs/methods.toStream.md b/docs/methods.toStream.md index fa8b3ae..0a46a6b 100644 --- a/docs/methods.toStream.md +++ b/docs/methods.toStream.md @@ -8,26 +8,26 @@ Creates a stream that gets updated whenever the property value changes or event is triggered. ```js -var DefineMap = require('can-define/map/map'); -var canStream = require("can-stream-kefir"); -var canDefineStream = require("can-define-stream"); - -var Person = DefineMap.extend({ - name: "string", - lastValidName: { - stream: function() { - return this.toStream(".name").filter(function(name) { // using propName - return name.indexOf(" ") >= 0; - }); - } - } -}); - -canDefineStream(canStream)(Person); - -var me = new Person({name: "James"}); - -me.on("lastValidName", function(lastValid) {}); +import DefineMap from "can-define/map/map"; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; + +const Person = DefineMap.extend( { + name: "string", + lastValidName: { + stream: function() { + return this.toStream( ".name" ).filter( function( name ) { // using propName + return name.indexOf( " " ) >= 0; + } ); + } + } +} ); + +canDefineStream( canStream )( Person ); + +const me = new Person( { name: "James" } ); + +me.on( "lastValidName", function( lastValid ) {} ); me.name = "JamesAtherton"; //lastValidName -> undefined me.name = "James Atherton"; //lastValidName -> James Atherton diff --git a/docs/methods.toStreamFromEvent.md b/docs/methods.toStreamFromEvent.md index f40f7c8..49180f6 100644 --- a/docs/methods.toStreamFromEvent.md +++ b/docs/methods.toStreamFromEvent.md @@ -9,29 +9,29 @@ Creates a stream from an event that gets updated whenever the event is triggered. ```js -var DefineList = require('can-define/list/list'); -var canStream = require("can-stream-kefir"); -var canDefineStream = require("can-define-stream"); +import DefineList from "can-define/list/list"; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; -var PeopleList = DefineList.extend({}); +const PeopleList = DefineList.extend( {} ); -canDefineStream(canStream)(PeopleList); +canDefineStream( canStream )( PeopleList ); -var people = new PeopleList([ - { first: "Justin", last: "Meyer" }, - { first: "Paula", last: "Strozak" } -]); +const people = new PeopleList( [ + { first: "Justin", last: "Meyer" }, + { first: "Paula", last: "Strozak" } +] ); -var stream = people.toStreamFromEvent('length'); // using eventName +const stream = people.toStreamFromEvent( "length" ); // using eventName -stream.onValue(function(val) { - val //-> 2, 3 -}); +stream.onValue( function( val ) { + val; //-> 2, 3 +} ); -people.push({ - first: 'Obaid', - last: 'Ahmed' -}); //-> stream.onValue -> 3 +people.push( { + first: "Obaid", + last: "Ahmed" +} ); //-> stream.onValue -> 3 ``` @param {String} event An event name diff --git a/docs/methods.toStreamFromProperty.md b/docs/methods.toStreamFromProperty.md index c924c4d..f8ee90e 100644 --- a/docs/methods.toStreamFromProperty.md +++ b/docs/methods.toStreamFromProperty.md @@ -8,26 +8,26 @@ Creates a stream from a property that gets updated whenever the property value changes. ```js -var DefineMap = require('can-define/map/map'); -var canStream = require("can-stream-kefir"); -var canDefineStream = require("can-define-stream"); - -var Person = DefineMap.extend({ - name: "string", - lastValidName: { - stream: function() { - return this.toStreamFromProperty(".name").filter(function(name) { // using propName - return name.indexOf(" ") >= 0; - }); - } - } -}); - -canDefineStream(canStream)(Person); - -var me = new Person({name: "James"}); - -me.on("lastValidName", function(lastValid) {}); +import DefineMap from "can-define/map/map"; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; + +const Person = DefineMap.extend( { + name: "string", + lastValidName: { + stream: function() { + return this.toStreamFromProperty( ".name" ).filter( function( name ) { // using propName + return name.indexOf( " " ) >= 0; + } ); + } + } +} ); + +canDefineStream( canStream )( Person ); + +const me = new Person( { name: "James" } ); + +me.on( "lastValidName", function( lastValid ) {} ); me.name = "JamesAtherton"; //lastValidName -> undefined me.name = "James Atherton"; //lastValidName -> James Atherton diff --git a/docs/types.DefineList.prototype.md b/docs/types.DefineList.prototype.md index 8bce796..9af0544 100644 --- a/docs/types.DefineList.prototype.md +++ b/docs/types.DefineList.prototype.md @@ -8,22 +8,22 @@ Creates a DefineList type instance ```js -import DefineMap from 'can-define/map/map'; -import DefineList from 'can-define/list/list'; +import DefineMap from "can-define/map/map"; +import DefineList from "can-define/list/list"; -var People = DefineList.extend([ - '#': { +const People = DefineList.extend( { + "#": { type: { - first: 'string', - last: 'string' + first: "string", + last: "string" } } -]); +} ); -var people = new People([ - { first: 'John', last: 'Gardner' }, - { first: 'Justin', last: 'Meyer' } -]) +const people = new People( [ + { first: "John", last: "Gardner" }, + { first: "Justin", last: "Meyer" } +] ); ``` @body diff --git a/docs/types.DefineMap.prototype.md b/docs/types.DefineMap.prototype.md index 5afb9fa..2ac289e 100644 --- a/docs/types.DefineMap.prototype.md +++ b/docs/types.DefineMap.prototype.md @@ -8,22 +8,22 @@ Creates a DefineMap type instance ```js -import DefineMap from 'can-define/map/map'; +import DefineMap from "can-define/map/map"; -var Person = DefineMap.extend({ - first: 'string', - last: 'string', +const Person = DefineMap.extend( { + first: "string", + last: "string", fullName: { get() { return this.first + " " + this.last; } } -}); +} ); -var john = new Person({ - first: 'John', - last: 'Gardner' -}); +const john = new Person( { + first: "John", + last: "Gardner" +} ); ``` @body diff --git a/docs/types.streamInterface.md b/docs/types.streamInterface.md index 7692453..67dc0e1 100644 --- a/docs/types.streamInterface.md +++ b/docs/types.streamInterface.md @@ -13,28 +13,28 @@ The stream interface function returned from [can-stream] that will be used to ad - .toCompute([can-stream.types.makeStream makeStream(setStream)], context):compute ```js -import DefineMap from 'can-define/map/map'; -import canDefineStream from 'can-define-stream'; -import streamInterface from 'can-stream-kefir'; +import DefineMap from "can-define/map/map"; +import canDefineStream from "can-define-stream"; +import streamInterface from "can-stream-kefir"; -var Person = DefineMap.extend({ +const Person = DefineMap.extend( { first: "string", last: "string", fullName: { - get: function() { - return this.first + " " + this.last; - } + get: function() { + return this.first + " " + this.last; + } } -}); +} ); -var john = new Person({ first: 'John' }); -john.toStream('.first'); //-> Error (toStream doesn't exist) +const john = new Person( { first: "John" } ); +john.toStream( ".first" ); //-> Error (toStream doesn't exist) -var defineStreamAdder = canDefineStream(streamInterface); -defineStreamAdder(Person); +const defineStreamAdder = canDefineStream( streamInterface ); +defineStreamAdder( Person ); -var justin = new Person({ first: 'Justin' }); -justin.toStream('.first'); //-> Stream +const justin = new Person( { first: "Justin" } ); +justin.toStream( ".first" ); //-> Stream ``` @body