From 815dacc122f802088b711846659d4deb81dfcac6 Mon Sep 17 00:00:00 2001 From: Christopher Baker Date: Mon, 12 Feb 2018 16:51:39 -0800 Subject: [PATCH 1/4] fix markdown code snippets --- docs/types.DefineList.prototype.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/types.DefineList.prototype.md b/docs/types.DefineList.prototype.md index 8bce796..136e589 100644 --- a/docs/types.DefineList.prototype.md +++ b/docs/types.DefineList.prototype.md @@ -11,14 +11,14 @@ Creates a DefineList type instance import DefineMap from 'can-define/map/map'; import DefineList from 'can-define/list/list'; -var People = DefineList.extend([ +var People = DefineList.extend({ '#': { type: { first: 'string', last: 'string' } } -]); +}); var people = new People([ { first: 'John', last: 'Gardner' }, From 8685d5c86e116bc64aab56ac54b37b6c34f510c6 Mon Sep 17 00:00:00 2001 From: Christopher Baker Date: Mon, 12 Feb 2018 17:11:40 -0800 Subject: [PATCH 2/4] Use const/let in sample code --- docs/can-define-stream.md | 40 ++++++++++++++-------------- docs/methods.toStream.md | 12 ++++----- docs/methods.toStreamFromEvent.md | 14 +++++----- docs/methods.toStreamFromProperty.md | 12 ++++----- docs/types.DefineList.prototype.md | 24 ++++++++--------- docs/types.DefineMap.prototype.md | 24 ++++++++--------- docs/types.streamInterface.md | 24 ++++++++--------- 7 files changed, 75 insertions(+), 75 deletions(-) diff --git a/docs/can-define-stream.md b/docs/can-define-stream.md index d057807..60a791d 100644 --- a/docs/can-define-stream.md +++ b/docs/can-define-stream.md @@ -11,12 +11,12 @@ 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"); +```javascript +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; +import DefineMap from "can-define/map/map"; -var Person = DefineMap.extend({ +const Person = DefineMap.extend({ first: "string", last: "string", fullName: { @@ -35,7 +35,7 @@ var Person = DefineMap.extend({ canDefineStream(canStream)(Person); -var me = new Person({name: "Justin", last: "Meyer"}); +const me = new Person({name: "Justin", last: "Meyer"}); me.on("fullNameChangeCount", function(ev, newVal) { console.log(newVal); @@ -55,7 +55,7 @@ me.last = "Ahmed"; //-> console.logs 2 The [can-define-stream.toStream] method has shorthands for all of the other methods: -```js +```javascript toStream("eventName") //-> stream toStream(".propName") //-> stream toStream(".propName eventName") //-> stream @@ -65,12 +65,12 @@ 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"); +```javascript +import DefineMap from 'can-define/map/map'; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; -var Person = DefineMap.extend({ +const Person = DefineMap.extend({ name: "string", lastValidName: { stream: function() { @@ -83,7 +83,7 @@ var Person = DefineMap.extend({ canDefineStream(canStream)(Person); -var me = new Person({name: "James"}); +const me = new Person({name: "James"}); me.on("lastValidName", function(lastValid) {}); @@ -93,21 +93,21 @@ 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"); +```javascript +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); -var people = new PeopleList([ +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 diff --git a/docs/methods.toStream.md b/docs/methods.toStream.md index fa8b3ae..0b47c7c 100644 --- a/docs/methods.toStream.md +++ b/docs/methods.toStream.md @@ -7,12 +7,12 @@ 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"); +```javascript +import DefineMap from 'can-define/map/map'; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; -var Person = DefineMap.extend({ +const Person = DefineMap.extend({ name: "string", lastValidName: { stream: function() { @@ -25,7 +25,7 @@ var Person = DefineMap.extend({ canDefineStream(canStream)(Person); -var me = new Person({name: "James"}); +const me = new Person({name: "James"}); me.on("lastValidName", function(lastValid) {}); diff --git a/docs/methods.toStreamFromEvent.md b/docs/methods.toStreamFromEvent.md index f40f7c8..a34c0d9 100644 --- a/docs/methods.toStreamFromEvent.md +++ b/docs/methods.toStreamFromEvent.md @@ -8,21 +8,21 @@ 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"); +```javascript +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); -var people = new PeopleList([ +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 diff --git a/docs/methods.toStreamFromProperty.md b/docs/methods.toStreamFromProperty.md index c924c4d..806c14c 100644 --- a/docs/methods.toStreamFromProperty.md +++ b/docs/methods.toStreamFromProperty.md @@ -7,12 +7,12 @@ 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"); +```javascript +import DefineMap from 'can-define/map/map'; +import canStream from "can-stream-kefir"; +import canDefineStream from "can-define-stream"; -var Person = DefineMap.extend({ +const Person = DefineMap.extend({ name: "string", lastValidName: { stream: function() { @@ -25,7 +25,7 @@ var Person = DefineMap.extend({ canDefineStream(canStream)(Person); -var me = new Person({name: "James"}); +const me = new Person({name: "James"}); me.on("lastValidName", function(lastValid) {}); diff --git a/docs/types.DefineList.prototype.md b/docs/types.DefineList.prototype.md index 136e589..0dcd35a 100644 --- a/docs/types.DefineList.prototype.md +++ b/docs/types.DefineList.prototype.md @@ -7,23 +7,23 @@ Creates a DefineList type instance -```js +```javascript import DefineMap from 'can-define/map/map'; import DefineList from 'can-define/list/list'; -var People = DefineList.extend({ - '#': { - type: { - first: 'string', - last: 'string' - } - } +const People = DefineList.extend({ + '#': { + type: { + 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..ff67192 100644 --- a/docs/types.DefineMap.prototype.md +++ b/docs/types.DefineMap.prototype.md @@ -7,22 +7,22 @@ Creates a DefineMap type instance -```js +```javascript import DefineMap from 'can-define/map/map'; -var Person = DefineMap.extend({ - first: 'string', - last: 'string', - fullName: { - get() { - return this.first + " " + this.last; - } - } +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' }); ``` diff --git a/docs/types.streamInterface.md b/docs/types.streamInterface.md index 7692453..8ddb157 100644 --- a/docs/types.streamInterface.md +++ b/docs/types.streamInterface.md @@ -12,28 +12,28 @@ The stream interface function returned from [can-stream] that will be used to ad - .toStreamFromEvent(property) - .toCompute([can-stream.types.makeStream makeStream(setStream)], context):compute -```js +```javascript import DefineMap from 'can-define/map/map'; import canDefineStream from 'can-define-stream'; import streamInterface from 'can-stream-kefir'; -var Person = DefineMap.extend({ - first: "string", - last: "string", - fullName: { - get: function() { - return this.first + " " + this.last; - } - } +const Person = DefineMap.extend({ + first: "string", + last: "string", + fullName: { + get: function() { + return this.first + " " + this.last; + } + } }); -var john = new Person({ first: 'John' }); +const john = new Person({ first: 'John' }); john.toStream('.first'); //-> Error (toStream doesn't exist) -var defineStreamAdder = canDefineStream(streamInterface); +const defineStreamAdder = canDefineStream(streamInterface); defineStreamAdder(Person); -var justin = new Person({ first: 'Justin' }); +const justin = new Person({ first: 'Justin' }); justin.toStream('.first'); //-> Stream ``` From 0470ed12103a5f953d1704bcc1d35df4774211d6 Mon Sep 17 00:00:00 2001 From: Christopher Baker Date: Tue, 13 Feb 2018 15:28:26 -0800 Subject: [PATCH 3/4] run eslint on markdown code --- docs/can-define-stream.md | 64 ++++++++++++++-------------- docs/methods.toStream.md | 18 ++++---- docs/methods.toStreamFromEvent.md | 12 +++--- docs/methods.toStreamFromProperty.md | 18 ++++---- docs/types.DefineList.prototype.md | 18 ++++---- docs/types.DefineMap.prototype.md | 20 ++++----- docs/types.streamInterface.md | 16 +++---- 7 files changed, 83 insertions(+), 83 deletions(-) diff --git a/docs/can-define-stream.md b/docs/can-define-stream.md index 60a791d..18791d1 100644 --- a/docs/can-define-stream.md +++ b/docs/can-define-stream.md @@ -11,26 +11,26 @@ 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. -```javascript +```js 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); - } - } + 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); @@ -38,7 +38,7 @@ canDefineStream(canStream)(Person); const me = new Person({name: "Justin", last: "Meyer"}); me.on("fullNameChangeCount", function(ev, newVal) { - console.log(newVal); + console.log(newVal); }); me.fullNameChangeCount //-> 0 me.first = "Obaid"; //-> console.logs 1 @@ -55,7 +55,7 @@ me.last = "Ahmed"; //-> console.logs 2 The [can-define-stream.toStream] method has shorthands for all of the other methods: -```javascript +```js toStream("eventName") //-> stream toStream(".propName") //-> stream toStream(".propName eventName") //-> stream @@ -65,20 +65,20 @@ For example: __Update map property based on stream value__ -```javascript +```js 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; - }); - } - } + name: "string", + lastValidName: { + stream: function() { + return this.toStream(".name").filter(function(name) { // using propName + return name.indexOf(" ") >= 0; + }); + } + } }); canDefineStream(canStream)(Person); @@ -93,7 +93,7 @@ me.name = "James Atherton"; //lastValidName -> James Atherton __Stream on DefineList__ -```javascript +```js import DefineList from 'can-define/list/list'; import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; @@ -103,18 +103,18 @@ const PeopleList = DefineList.extend({}); canDefineStream(canStream)(PeopleList); const people = new PeopleList([ - { first: "Justin", last: "Meyer" }, - { first: "Paula", last: "Strozak" } + { first: "Justin", last: "Meyer" }, + { first: "Paula", last: "Strozak" } ]); const stream = people.toStream('length'); // using eventName stream.onValue(function(val) { - val //-> 2, 3 + val //-> 2, 3 }); people.push({ - first: 'Obaid', - last: 'Ahmed' + first: 'Obaid', + last: 'Ahmed' }); //-> stream.onValue -> 3 ``` diff --git a/docs/methods.toStream.md b/docs/methods.toStream.md index 0b47c7c..e1ff116 100644 --- a/docs/methods.toStream.md +++ b/docs/methods.toStream.md @@ -7,20 +7,20 @@ Creates a stream that gets updated whenever the property value changes or event is triggered. -```javascript +```js 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; - }); - } - } + name: "string", + lastValidName: { + stream: function() { + return this.toStream(".name").filter(function(name) { // using propName + return name.indexOf(" ") >= 0; + }); + } + } }); canDefineStream(canStream)(Person); diff --git a/docs/methods.toStreamFromEvent.md b/docs/methods.toStreamFromEvent.md index a34c0d9..0b62dad 100644 --- a/docs/methods.toStreamFromEvent.md +++ b/docs/methods.toStreamFromEvent.md @@ -8,7 +8,7 @@ Creates a stream from an event that gets updated whenever the event is triggered. -```javascript +```js import DefineList from 'can-define/list/list'; import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; @@ -18,19 +18,19 @@ const PeopleList = DefineList.extend({}); canDefineStream(canStream)(PeopleList); const people = new PeopleList([ - { first: "Justin", last: "Meyer" }, - { first: "Paula", last: "Strozak" } + { first: "Justin", last: "Meyer" }, + { first: "Paula", last: "Strozak" } ]); const stream = people.toStreamFromEvent('length'); // using eventName stream.onValue(function(val) { - val //-> 2, 3 + val //-> 2, 3 }); people.push({ - first: 'Obaid', - last: 'Ahmed' + first: 'Obaid', + last: 'Ahmed' }); //-> stream.onValue -> 3 ``` diff --git a/docs/methods.toStreamFromProperty.md b/docs/methods.toStreamFromProperty.md index 806c14c..6e4366e 100644 --- a/docs/methods.toStreamFromProperty.md +++ b/docs/methods.toStreamFromProperty.md @@ -7,20 +7,20 @@ Creates a stream from a property that gets updated whenever the property value changes. -```javascript +```js 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; - }); - } - } + name: "string", + lastValidName: { + stream: function() { + return this.toStreamFromProperty(".name").filter(function(name) { // using propName + return name.indexOf(" ") >= 0; + }); + } + } }); canDefineStream(canStream)(Person); diff --git a/docs/types.DefineList.prototype.md b/docs/types.DefineList.prototype.md index 0dcd35a..67816cb 100644 --- a/docs/types.DefineList.prototype.md +++ b/docs/types.DefineList.prototype.md @@ -7,22 +7,22 @@ Creates a DefineList type instance -```javascript +```js import DefineMap from 'can-define/map/map'; import DefineList from 'can-define/list/list'; const People = DefineList.extend({ - '#': { - type: { - first: 'string', - last: 'string' - } - } + '#': { + type: { + first: 'string', + last: 'string' + } + } }); const people = new People([ - { first: 'John', last: 'Gardner' }, - { first: 'Justin', last: 'Meyer' } + { first: 'John', last: 'Gardner' }, + { first: 'Justin', last: 'Meyer' } ]); ``` diff --git a/docs/types.DefineMap.prototype.md b/docs/types.DefineMap.prototype.md index ff67192..35f9dbc 100644 --- a/docs/types.DefineMap.prototype.md +++ b/docs/types.DefineMap.prototype.md @@ -7,22 +7,22 @@ Creates a DefineMap type instance -```javascript +```js import DefineMap from 'can-define/map/map'; const Person = DefineMap.extend({ - first: 'string', - last: 'string', - fullName: { - get() { - return this.first + " " + this.last; - } - } + first: 'string', + last: 'string', + fullName: { + get() { + return this.first + " " + this.last; + } + } }); const john = new Person({ - first: 'John', - last: 'Gardner' + first: 'John', + last: 'Gardner' }); ``` diff --git a/docs/types.streamInterface.md b/docs/types.streamInterface.md index 8ddb157..aeb98ba 100644 --- a/docs/types.streamInterface.md +++ b/docs/types.streamInterface.md @@ -12,19 +12,19 @@ The stream interface function returned from [can-stream] that will be used to ad - .toStreamFromEvent(property) - .toCompute([can-stream.types.makeStream makeStream(setStream)], context):compute -```javascript +```js import DefineMap from 'can-define/map/map'; import canDefineStream from 'can-define-stream'; import streamInterface from 'can-stream-kefir'; const Person = DefineMap.extend({ - first: "string", - last: "string", - fullName: { - get: function() { - return this.first + " " + this.last; - } - } + first: "string", + last: "string", + fullName: { + get: function() { + return this.first + " " + this.last; + } + } }); const john = new Person({ first: 'John' }); From 814396c57f944ad86ef6b61a50fad7715376a098 Mon Sep 17 00:00:00 2001 From: Christopher Baker Date: Tue, 13 Feb 2018 16:56:18 -0800 Subject: [PATCH 4/4] run eslint on markdown code --- docs/can-define-stream.md | 70 ++++++++++++++-------------- docs/methods.toStream.md | 18 +++---- docs/methods.toStreamFromEvent.md | 26 +++++------ docs/methods.toStreamFromProperty.md | 18 +++---- docs/types.DefineList.prototype.md | 22 ++++----- docs/types.DefineMap.prototype.md | 18 +++---- docs/types.streamInterface.md | 22 ++++----- 7 files changed, 97 insertions(+), 97 deletions(-) diff --git a/docs/can-define-stream.md b/docs/can-define-stream.md index 18791d1..c51c69d 100644 --- a/docs/can-define-stream.md +++ b/docs/can-define-stream.md @@ -16,7 +16,7 @@ import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; import DefineMap from "can-define/map/map"; -const Person = DefineMap.extend({ +const Person = DefineMap.extend( { first: "string", last: "string", fullName: { @@ -26,21 +26,21 @@ const Person = DefineMap.extend({ }, fullNameChangeCount: { stream: function() { - return this.toStream(".fullName").scan(function(last) { + return this.toStream( ".fullName" ).scan( function( last ) { return last + 1; - }, 0); + }, 0 ); } } -}); +} ); -canDefineStream(canStream)(Person); +canDefineStream( canStream )( Person ); -const me = new Person({name: "Justin", last: "Meyer"}); +const me = new Person( { name: "Justin", last: "Meyer" } ); -me.on("fullNameChangeCount", function(ev, newVal) { - console.log(newVal); -}); -me.fullNameChangeCount //-> 0 +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 -import DefineMap from 'can-define/map/map'; +import DefineMap from "can-define/map/map"; import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; -const Person = DefineMap.extend({ +const Person = DefineMap.extend( { name: "string", lastValidName: { stream: function() { - return this.toStream(".name").filter(function(name) { // using propName - return name.indexOf(" ") >= 0; - }); + return this.toStream( ".name" ).filter( function( name ) { // using propName + return name.indexOf( " " ) >= 0; + } ); } } -}); +} ); -canDefineStream(canStream)(Person); +canDefineStream( canStream )( Person ); -const 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 -import DefineList from 'can-define/list/list'; +import DefineList from "can-define/list/list"; import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; -const PeopleList = DefineList.extend({}); +const PeopleList = DefineList.extend( {} ); -canDefineStream(canStream)(PeopleList); +canDefineStream( canStream )( PeopleList ); -const people = new PeopleList([ +const people = new PeopleList( [ { first: "Justin", last: "Meyer" }, { first: "Paula", last: "Strozak" } -]); +] ); -const 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 e1ff116..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 -import DefineMap from 'can-define/map/map'; +import DefineMap from "can-define/map/map"; import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; -const Person = DefineMap.extend({ +const Person = DefineMap.extend( { name: "string", lastValidName: { stream: function() { - return this.toStream(".name").filter(function(name) { // using propName - return name.indexOf(" ") >= 0; - }); + return this.toStream( ".name" ).filter( function( name ) { // using propName + return name.indexOf( " " ) >= 0; + } ); } } -}); +} ); -canDefineStream(canStream)(Person); +canDefineStream( canStream )( Person ); -const 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 diff --git a/docs/methods.toStreamFromEvent.md b/docs/methods.toStreamFromEvent.md index 0b62dad..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 -import DefineList from 'can-define/list/list'; +import DefineList from "can-define/list/list"; import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; -const PeopleList = DefineList.extend({}); +const PeopleList = DefineList.extend( {} ); -canDefineStream(canStream)(PeopleList); +canDefineStream( canStream )( PeopleList ); -const people = new PeopleList([ +const people = new PeopleList( [ { first: "Justin", last: "Meyer" }, { first: "Paula", last: "Strozak" } -]); +] ); -const 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 6e4366e..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 -import DefineMap from 'can-define/map/map'; +import DefineMap from "can-define/map/map"; import canStream from "can-stream-kefir"; import canDefineStream from "can-define-stream"; -const Person = DefineMap.extend({ +const Person = DefineMap.extend( { name: "string", lastValidName: { stream: function() { - return this.toStreamFromProperty(".name").filter(function(name) { // using propName - return name.indexOf(" ") >= 0; - }); + return this.toStreamFromProperty( ".name" ).filter( function( name ) { // using propName + return name.indexOf( " " ) >= 0; + } ); } } -}); +} ); -canDefineStream(canStream)(Person); +canDefineStream( canStream )( Person ); -const 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 diff --git a/docs/types.DefineList.prototype.md b/docs/types.DefineList.prototype.md index 67816cb..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"; -const People = DefineList.extend({ - '#': { +const People = DefineList.extend( { + "#": { type: { - first: 'string', - last: 'string' + first: "string", + last: "string" } } -}); +} ); -const 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 35f9dbc..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"; -const Person = DefineMap.extend({ - first: 'string', - last: 'string', +const Person = DefineMap.extend( { + first: "string", + last: "string", fullName: { get() { return this.first + " " + this.last; } } -}); +} ); -const 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 aeb98ba..67dc0e1 100644 --- a/docs/types.streamInterface.md +++ b/docs/types.streamInterface.md @@ -13,11 +13,11 @@ 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"; -const Person = DefineMap.extend({ +const Person = DefineMap.extend( { first: "string", last: "string", fullName: { @@ -25,16 +25,16 @@ const Person = DefineMap.extend({ return this.first + " " + this.last; } } -}); +} ); -const 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) -const defineStreamAdder = canDefineStream(streamInterface); -defineStreamAdder(Person); +const defineStreamAdder = canDefineStream( streamInterface ); +defineStreamAdder( Person ); -const justin = new Person({ first: 'Justin' }); -justin.toStream('.first'); //-> Stream +const justin = new Person( { first: "Justin" } ); +justin.toStream( ".first" ); //-> Stream ``` @body