Merge pull request #496 from 38elements/master

mattpodwysocki · mattpodwysocki · commit a737a61db8b2 · 2015-01-15T04:36:11.000-05:00
Update document
diff --git a/doc/api/core/notification.md b/doc/api/core/notification.md
@@ -30,7 +30,7 @@ Creates an object that represents an OnCompleted notification to an observer.
 #### Example
 ```js
 var source = Rx.Observable
-    .fromArray([
+    .from([
         Rx.Notification.createOnCompleted()
     ])
     .dematerialize();
@@ -69,7 +69,7 @@ Creates an object that represents an OnError notification to an observer.
 #### Example
 ```js
 var source = Rx.Observable
-    .fromArray([
+    .from([
         Rx.Notification.createOnError(new Error('woops'))
     ])
     .dematerialize();
@@ -108,7 +108,7 @@ Creates an object that represents an OnNext notification to an observer.
 #### Example
 ```js
 var source = Rx.Observable
-    .fromArray([
+    .from([
         Rx.Notification.createOnNext(42),
         Rx.Notification.createOnCompleted()
     ])
diff --git a/doc/api/core/observable.md b/doc/api/core/observable.md
@@ -18,7 +18,6 @@ The Observer and Observable interfaces provide a generalized mechanism for push-
 - [`for | forIn`](operators/for.md)
 - [`forkJoin`](operators/forkjoin.md)
 - [`from`](operators/from.md)
-- [`fromArray`](operators/fromarray.md)
 - [`fromCallback`](operators/fromcallback.md)
 - [`fromEvent`](operators/fromevent.md)
 - [`fromEventPattern`](operators/fromeventpattern.md)
@@ -199,6 +198,7 @@ The Observer and Observable interfaces provide a generalized mechanism for push-
 
 ## `Deprecated Observable Methods` ##
 - [`catchException`](operators/catch.md)
+- [`fromArray`](operators/fromarray.md)
 - [`returnValue`](operators/return.md)
 - [`throwException`](operators/throw.md)
 
diff --git a/doc/api/core/operators/average.md b/doc/api/core/operators/average.md
@@ -35,7 +35,7 @@ var arr = [
     { value: 3 }
 ];
 
-var source = Rx.Observable.fromArray(arr).average(function (x) {
+var source = Rx.Observable.from(arr).average(function (x) {
     return x.value;
 });
 
diff --git a/doc/api/core/operators/debounce.md b/doc/api/core/operators/debounce.md
@@ -1,7 +1,7 @@
 ### `Rx.Observable.prototype.debounce(dueTime, [scheduler])` ###
 ### `Rx.Observable.prototype.throttleWithTimeout(dueTime, [scheduler])` ###
 ### `Rx.Observable.prototype.throttle(dueTime, [scheduler])` **DEPRECATED** ###
-[&#x24C8;](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/linq/observable/throttle.js "View in source")
+[&#x24C8;](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/linq/observable/debounce.js "View in source")
 
 Emits an item from the source Observable after a particular timespan has passed without the Observable emitting any other items.
 
diff --git a/doc/api/core/operators/dematerialize.md b/doc/api/core/operators/dematerialize.md
@@ -9,7 +9,7 @@ Dematerializes the explicit notification values of an observable sequence as imp
 #### Example
 ```js
 var source = Rx.Observable
-    .fromArray([
+    .from([
         Rx.Notification.createOnNext(42),
         Rx.Notification.createOnError(new Error('woops'))
     ])
diff --git a/doc/api/core/operators/distinct.md b/doc/api/core/operators/distinct.md
@@ -13,7 +13,7 @@ Returns an observable sequence that contains only distinct elements according to
 #### Example
 ```js
 /* Without key selector */
-var source = Rx.Observable.fromArray([
+var source = Rx.Observable.from([
         42, 24, 42, 24
     ])
     .distinct();
@@ -34,7 +34,7 @@ var subscription = source.subscribe(
 // => Completed
 
 /* With key selector */
-var source = Rx.Observable.fromArray([
+var source = Rx.Observable.from([
         {value: 42}, {value: 24}, {value: 42}, {value: 24}
     ])
     .distinct(function (x) { return x.value; });
diff --git a/doc/api/core/operators/distinctuntilchanged.md b/doc/api/core/operators/distinctuntilchanged.md
@@ -13,7 +13,7 @@ Returns an observable sequence that contains only distinct contiguous elements a
 #### Example
 ```js
 /* Without key selector */
-var source = Rx.Observable.fromArray([
+var source = Rx.Observable.from([
         42, 42, 24, 24
     ])
     .distinctUntilChanged();
@@ -34,7 +34,7 @@ var subscription = source.subscribe(
 // => Completed
 
 /* With key selector */
-var source = Rx.Observable.fromArray([
+var source = Rx.Observable.from([
         {value: 42}, {value: 42}, {value: 24}, {value: 24}
     ])
     .distinctUntilChanged(function (x) { return x.value; });
diff --git a/doc/api/core/operators/elementat.md b/doc/api/core/operators/elementat.md
@@ -12,7 +12,7 @@ Returns the element at a specified index in a sequence.
 #### Example
 ```js
 /* Finds an index */
-var source = Rx.Observable.fromArray([1,2,3,4])
+var source = Rx.Observable.from([1,2,3,4])
     .elementAt(1);
 
 var subscription = source.subscribe(
@@ -30,7 +30,7 @@ var subscription = source.subscribe(
 // => Completed
 
 /* Not found */
-var source = Rx.Observable.fromArray([1,2,3,4])
+var source = Rx.Observable.from([1,2,3,4])
     .elementAt(4);
 
 var subscription = source.subscribe(
diff --git a/doc/api/core/operators/elementatordefault.md b/doc/api/core/operators/elementatordefault.md
@@ -13,8 +13,8 @@ Returns the element at a specified index in a sequence.
 #### Example
 ```js
 /* Finds an index */
-var source = Rx.Observable.fromArray([1,2,3,4])
-    .elementAt(1);
+var source = Rx.Observable.from([1,2,3,4])
+    .elementAtOrDefault(1);
 
 var subscription = source.subscribe(
     function (x) {
@@ -31,8 +31,8 @@ var subscription = source.subscribe(
 // => Completed
 
 /* Not found */
-var source = Rx.Observable.fromArray([1,2,3,4])
-    .elementAt(4, 0);
+var source = Rx.Observable.from([1,2,3,4])
+    .elementAtOrDefault(4, 0);
 
 var subscription = source.subscribe(
     function (x) {
diff --git a/doc/api/core/operators/find.md b/doc/api/core/operators/find.md
@@ -17,7 +17,7 @@ Searches for an element that matches the conditions defined by the specified pre
 /* Found an element */
 var array = [1,2,3,4];
 
-var source = Rx.Observable.fromArray(array)
+var source = Rx.Observable.from(array)
     .find(function (x, i, obs) {
         return x === 1;
     });
@@ -39,7 +39,7 @@ var subscription = source.subscribe(
 /* Not found */
 var array = [1,2,3,4];
 
-var source = Rx.Observable.fromArray(array)
+var source = Rx.Observable.from(array)
     .find(function (x, i, obs) {
         return x === 5;
     });
diff --git a/doc/api/core/operators/findindex.md b/doc/api/core/operators/findindex.md
@@ -18,7 +18,7 @@ Searches for an element that matches the conditions defined by the specified pre
 /* Found an element */
 var array = [1,2,3,4];
 
-var source = Rx.Observable.fromArray(array)
+var source = Rx.Observable.from(array)
     .findIndex(function (x, i, obs) {
         return x === 1;
     });
@@ -40,7 +40,7 @@ var subscription = source.subscribe(
 /* Not found */
 var array = [1,2,3,4];
 
-var source = Rx.Observable.fromArray(array)
+var source = Rx.Observable.from(array)
     .findIndex(function (x, i, obs) {
         return x === 5;
     });
diff --git a/doc/api/core/operators/forkjoin.md b/doc/api/core/operators/forkjoin.md
@@ -15,7 +15,7 @@ Runs all observable sequences in parallel and collect their last elements.
 var source = Rx.Observable.forkJoin(
     Rx.Observable.return(42),
     Rx.Observable.range(0, 10),
-    Rx.Observable.fromArray([1,2,3]),
+    Rx.Observable.from([1,2,3]),
     RSVP.Promise.resolve(56)
 );
 
diff --git a/doc/api/core/operators/groupby.md b/doc/api/core/operators/groupby.md
@@ -26,7 +26,7 @@ var codes = [
     { keyCode: 65}  // a
 ];
 
-var source = Rx.Observable.fromArray(codes)
+var source = Rx.Observable.from(codes)
     .groupBy(
         function (x) { return x.keyCode; },
         function (x) { return x.keyCode; });
diff --git a/doc/api/core/operators/max.md b/doc/api/core/operators/max.md
@@ -12,7 +12,7 @@ Returns the maximum value in an observable sequence according to the specified c
 #### Example
 ```js
 /* Without comparer */
-var source = Rx.Observable.fromArray([1,3,5,7,9,2,4,6,8])
+var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8])
     .max();
 
 var subscription = source.subscribe(
@@ -39,7 +39,7 @@ function comparer (x, y) {
     return 0;
 }
 
-var source = Rx.Observable.fromArray([1,3,5,7,9,2,4,6,8])
+var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8])
     .max(comparer);
 
 var subscription = source.subscribe(
diff --git a/doc/api/core/operators/maxby.md b/doc/api/core/operators/maxby.md
@@ -13,7 +13,7 @@ Returns the maximum value in an observable sequence according to the specified c
 #### Example
 ```js
 /* Without comparer */
-var source = Rx.Observable.fromArray([1,3,5,7,9,2,4,6,8,9])
+var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8,9])
     .maxBy(function (x) { return x; });
 
 var subscription = source.subscribe(
diff --git a/doc/api/core/operators/min.md b/doc/api/core/operators/min.md
@@ -12,7 +12,7 @@ Returns the minimum element in an observable sequence according to the optional
 #### Example
 ```js
 /* Without comparer */
-var source = Rx.Observable.fromArray([1,3,5,7,9,2,4,6,8])
+var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8])
     .min();
 
 var subscription = source.subscribe(
@@ -39,7 +39,7 @@ function comparer (x, y) {
     return 0;
 }
 
-var source = Rx.Observable.fromArray([1,3,5,7,9,2,4,6,8])
+var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8])
     .min(comparer);
 
 var subscription = source.subscribe(
diff --git a/doc/api/core/operators/minby.md b/doc/api/core/operators/minby.md
@@ -13,7 +13,7 @@ Returns the elements in an observable sequence with the minimum key value accord
 #### Example
 ```js
 /* Without comparer */
-var source = Rx.Observable.fromArray([1,3,5,7,9,2,4,6,8,1])
+var source = Rx.Observable.from([1,3,5,7,9,2,4,6,8,1])
     .minBy(function (x) { return x; });
 
 var subscription = source.subscribe(
diff --git a/doc/api/core/operators/pluck.md b/doc/api/core/operators/pluck.md
@@ -12,7 +12,7 @@ Projects each element of an observable sequence into a new form by incorporating
 #### Example
 ```js
 var source = Rx.Observable
-    .fromArray([
+    .from([
         { value: 0 },
         { value: 1 },
         { value: 2 }
diff --git a/doc/api/core/operators/sum.md b/doc/api/core/operators/sum.md
@@ -40,7 +40,7 @@ var array = [
 ];
 
 var source = Rx.Observable
-    .fromArray(array)
+    .from(array)
     .sum(function (x, idx, obs) {
         return x.value;
     });
diff --git a/doc/api/core/operators/throttlefirst.md b/doc/api/core/operators/throttlefirst.md
@@ -1,7 +1,7 @@
 ### `Rx.Observable.prototype.throttleFirst(windowDuration, [scheduler])`
 [&#x24C8;](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/linq/observable/throttlefirst.js "View in source")
 
-Ignores values from an observable sequence which are followed by another value before dueTime.
+Returns an Observable that emits only the first item emitted by the source Observable during sequential time windows of a specified duration.
 
 #### Arguments
 1. `windowDuration` *(`Number`)*: Time to wait before emitting another item after emitting the last item (specified as an integer denoting milliseconds).
@@ -27,7 +27,7 @@ var source = Rx.Observable.from(times)
       .of(item.value)
       .delay(item.time);
   })
-  .throttleFirst(500 /* ms */);
+  .throttleFirst(300 /* ms */);
 
 var subscription = source.subscribe(
   function (x) {
diff --git a/doc/gettingstarted/querying.md b/doc/gettingstarted/querying.md
@@ -82,7 +82,7 @@ In the following example, we project a sequence of strings into an a series of i
 ```js
 var array = ['Reactive', 'Extensions', 'RxJS'];
 
-var seqString = Rx.Observable.fromArray(array);
+var seqString = Rx.Observable.from(array);
 
 var seqNum = seqString.map(function (x) { return x.length; });
 
diff --git a/doc/mapping/async/comparing.md b/doc/mapping/async/comparing.md
@@ -269,7 +269,7 @@ var Rx = require('rx'),
     fs = require('fs');
 
 Rx.Observable
-  .fromArray([1,2,3], Rx.Scheduler.timeout)
+  .from([1,2,3], Rx.Scheduler.timeout)
   .reduce(function (acc, x) { return acc + x; }, 0)
   .forEach( function (results) { console.log(results); });
 // => 6
