Merge pull request #512 from chicoxyzzy/master

actualize docs + replace deprecated throttleWithSelector operator by debounceWithSelector in tests and filenames

Author: mattpodwysocki

Gruntfile.js

@@ -291,7 +291,7 @@ var browsers = [{
               'src/core/linq/observable/delaysubscription.js', // delayWithSelector, timer, empty
               'src/core/linq/observable/delaywithselector.js',
               'src/core/linq/observable/timeoutwithselector.js',
-              'src/core/linq/observable/throttlewithselector.js',
+              'src/core/linq/observable/debouncewithselector.js',
               'src/core/linq/observable/skiplastwithtime.js',
               'src/core/linq/observable/takelastwithtime.js',
               'src/core/linq/observable/takelastbufferwithtime.js',
@@ -578,7 +578,7 @@ var browsers = [{
               'src/core/linq/observable/delaysubscription.js', // delayWithSelector, timer, empty
               'src/core/linq/observable/delaywithselector.js',
               'src/core/linq/observable/timeoutwithselector.js',
-              'src/core/linq/observable/throttlewithselector.js',
+              'src/core/linq/observable/debouncewithselector.js',
               'src/core/linq/observable/skiplastwithtime.js',
               'src/core/linq/observable/takelastwithtime.js',
               'src/core/linq/observable/takelastbufferwithtime.js',
@@ -1490,7 +1490,7 @@ var browsers = [{
               'src/core/linq/observable/delaysubscription.js', // delayWithSelector, timer, empty
               'src/core/linq/observable/delaywithselector.js',
               'src/core/linq/observable/timeoutwithselector.js',
-              'src/core/linq/observable/throttlewithselector.js',
+              'src/core/linq/observable/debouncewithselector.js',
               'src/core/linq/observable/skiplastwithtime.js',
               'src/core/linq/observable/takelastwithtime.js',
               'src/core/linq/observable/takelastbufferwithtime.js',

doc/api/core/observable.md

@@ -209,7 +209,8 @@ The Observer and Observable interfaces provide a generalized mechanism for push-
 - [`doAction`](operators/do.md)
 - [`catchException`](operators/catchproto.md)
 - [`concatObservable`](operators/concatall.md)
+- [`contains`](operators/includes.md)
 - [`finallyAction`](operators/finally.md)
 - [`mergeObservable`](operators/mergeall.md)
 - [`throttle`](operators/debounce.md)
-- [`throttleWithSelector`](operators/throttlewithselector.md)
+- [`throttleWithSelector`](operators/debouncewithselector.md)

…i/core/operators/throttlewithselector.md …i/core/operators/debouncewithselector.mddoc/api/core/operators/throttlewithselector.md renamed to doc/api/core/operators/debouncewithselector.md doc/api/core/operators/throttlewithselector.md renamed to doc/api/core/operators/debouncewithselector.md

@@ -1,6 +1,6 @@
 ### `Rx.Observable.prototype.debounceWithSelector(durationSelector)` ###
 ### `Rx.Observable.prototype.throttleWithSelector(durationSelector)` **DEPRECATED** ###
-[Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/linq/observable/throttlewithselector.js "View in source")
+[Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/linq/observable/debouncewithselector.js "View in source")
 
 Ignores values from an observable sequence which are followed by another value within a computed debounced duration.
 
@@ -25,7 +25,7 @@ var source = Rx.Observable.for(
         return Rx.Observable.timer(x)
     })
     .map(function(x, i) { return i; })
-    .throttleWithSelector(function (x) {
+    .debounceWithSelector(function (x) {
         return Rx.Observable.timer(700);
     });
 
@@ -48,7 +48,7 @@ var subscription = source.subscribe(
 ### Location
 
 File:
-- [`/src/core/linq/observable/throttlewithselector.js`](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/linq/observable/throttlewithselector.js)
+- [`/src/core/linq/observable/debouncewithselector.js`](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/linq/observable/debouncewithselector.js)
 
 Dist:
 - [`rx.all.js`](https://github.com/Reactive-Extensions/RxJS/blob/master/dist/rx.all.js)
@@ -69,4 +69,4 @@ NuGet Packages:
 - [`RxJS-Time`](http://www.nuget.org/packages/RxJS-Time/)
 
 Unit Tests:
-- [`/tests/observable/throttlewithselector.js`](https://github.com/Reactive-Extensions/RxJS/blob/master/tests/observable/throttlewithselector.js)
+- [`/tests/observable/debouncewithselector.js`](https://github.com/Reactive-Extensions/RxJS/blob/master/tests/observable/debouncewithselector.js)

doc/gettingstarted/categories.md

@@ -99,10 +99,10 @@ This topic lists all major operators implemented by the [`Observable`](https://g
    <td>Time-based operations</td>
    <td>
    <ol>
+   <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/debounce.md">debounce</a></li>
+   <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/debouncewithselector.md">debounceWithSelector</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/delay.md">delay</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/interval.md">interval</a></li>
-   <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/throttle.md">throttle</a></li>
-   <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/throwttlewithselector.md">throttleWithSelector</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/timeinterval.md">timeInterval</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/timer.md">timer</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/timeout.md">timeout</a></li>
@@ -140,6 +140,7 @@ This topic lists all major operators implemented by the [`Observable`](https://g
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/findindex.md">findIndex</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/first.md">first</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/firstordefault.md">firstOrDefault</a></li>
+   <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/includes.md">includes</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/last.md">last</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/lastordefault.md">lastOrDefault</a></li>
    <li><a href="https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/select.md">map</a></li>

doc/gettingstarted/promises.md

@@ -27,7 +27,7 @@ The following list of operators natively support Promises:
 - [`Rx.Observable.startAsync`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/startasync.md)
 - [`Rx.Observable.prototype.switch`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/switch.md)
 - [`Rx.Observable.prototype.takeUntil`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/takeuntil.md)
-- [`Rx.Observable.prototype.throttleWithSelector`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/throttlewithselector.md)
+- [`Rx.Observable.prototype.debounceWithSelector`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/debouncewithselector.md)
 - [`Rx.Observable.prototype.timeoutWithSelector`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/timeoutwithselector.md)
 - [`Rx.Observable.while`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/while.md)
 - [`Rx.Observable.prototype.window`](https://github.com/Reactive-Extensions/RxJS/tree/master/doc/api/core/operators/window.md)

doc/libraries/rx.complete.md

@@ -170,8 +170,8 @@ NuGet Packages:
 - [`takeUntil`](../api/core/operators/rxobservableprototypetakeuntilother)
 - [`takeUntilWithTime`](../api/core/operators/rxobservableprototypetakeuntilwithtimeendtime-scheduler)
 - [`takeWhile`](../api/core/operators/rxobservableprototypetakewhilepredicate-thisarg)
-- [`throttle`](../api/core/operators/rxobservableprototypethrottleduetime-scheduler)
-- [`throttleWithSelector`](../api/core/operators/rxobservableprototypethrottlewithselectorthrottleselector)
+- [`debounce`](../api/core/operators/rxobservableprototypethrottleduetime-scheduler)
+- [`debounceWithSelector`](../api/core/operators/rxobservableprototypedebouncewithselectorthrottleselector)
 - [`timeInterval`](../api/core/operators/rxobservableprototypetimeintervalscheduler)
 - [`timeout`](../api/core/operators/rxobservableprototypetimeoutduetime-other-scheduler)
 - [`timeoutWithSelector`](../api/core/operators/rxobservableprototypetimeoutwithselectorfirsttimeout-timeoutdurationselector-other)

doc/libraries/rx.time.md

@@ -40,7 +40,7 @@ NuGet Dependencies:
 - [`takeLastBufferWithTime`](../api/core/operators/takelastbufferwithtime.md)
 - [`takeLastWithTime`](../api/core/operators/takelastwithtime.md)
 - [`throttleFirst`](../api/core/operators/throttlefirst.md)
-- [`throttleWithSelector`](../api/core/operators/throttlewithselector.md)
+- [`debounceWithSelector`](../api/core/operators/debouncewithselector.md)
 - [`throttleWithTimeout`](../api/core/operators/debounce.md)
 - [`timeInterval`](../api/core/operators/timeinterval.md)
 - [`timeout`](../api/core/operators/timeout.md)

…/linq/observable/throttlewithselector.js …/linq/observable/debouncewithselector.jssrc/core/linq/observable/throttlewithselector.js renamed to src/core/linq/observable/debouncewithselector.js src/core/linq/observable/throttlewithselector.js renamed to src/core/linq/observable/debouncewithselector.js

@@ -1,4 +1,4 @@
-QUnit.module('Throttle');
+QUnit.module('Debounce');
 
 var Observable = Rx.Observable,
     TestScheduler = Rx.TestScheduler,
@@ -7,7 +7,7 @@ var Observable = Rx.Observable,
     onCompleted = Rx.ReactiveTest.onCompleted,
     subscribe = Rx.ReactiveTest.subscribe;
 
-test('Throttle_TimeSpan_AllPass', function () {
+test('Debounce_TimeSpan_AllPass', function () {
     var scheduler = new TestScheduler();
 
     var xs = scheduler.createHotObservable(
@@ -20,7 +20,7 @@ test('Throttle_TimeSpan_AllPass', function () {
     );
 
     var res = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function () { return Observable.timer(20, scheduler); });
+        return xs.debounceWithSelector(function () { return Observable.timer(20, scheduler); });
     });
 
     res.messages.assertEqual(
@@ -36,7 +36,7 @@ test('Throttle_TimeSpan_AllPass', function () {
     );
 });
 
-test('Throttle_TimeSpan_AllPass_ErrorEnd', function () {
+test('Debounce_TimeSpan_AllPass_ErrorEnd', function () {
     var ex = new Error();
 
     var scheduler = new TestScheduler();
@@ -51,7 +51,7 @@ test('Throttle_TimeSpan_AllPass_ErrorEnd', function () {
     );
 
     var res = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function () { return Observable.timer(20, scheduler); });
+        return xs.debounceWithSelector(function () { return Observable.timer(20, scheduler); });
     });
 
     res.messages.assertEqual(
@@ -67,7 +67,7 @@ test('Throttle_TimeSpan_AllPass_ErrorEnd', function () {
     );
 });
 
-test('Throttle_TimeSpan_AllDrop', function () {
+test('Debounce_TimeSpan_AllDrop', function () {
     var scheduler = new TestScheduler();
 
     var xs = scheduler.createHotObservable(
@@ -83,7 +83,7 @@ test('Throttle_TimeSpan_AllDrop', function () {
     );
 
     var res = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function () { return Observable.timer(40, scheduler); });
+        return xs.debounceWithSelector(function () { return Observable.timer(40, scheduler); });
     });
 
     res.messages.assertEqual(
@@ -96,7 +96,7 @@ test('Throttle_TimeSpan_AllDrop', function () {
     );
 });
 
-test('Throttle_TimeSpan_AllDrop_ErrorEnd', function () {
+test('Debounce_TimeSpan_AllDrop_ErrorEnd', function () {
     var ex = new Error();
 
     var scheduler = new TestScheduler();
@@ -114,7 +114,7 @@ test('Throttle_TimeSpan_AllDrop_ErrorEnd', function () {
     );
 
     var res = scheduler.startWithCreate(function () {
-        return xs.throttle(40, scheduler)
+        return xs.debounce(40, scheduler)
     });
 
     res.messages.assertEqual(
@@ -126,7 +126,7 @@ test('Throttle_TimeSpan_AllDrop_ErrorEnd', function () {
     );
 });
 
-test('Throttle_Duration_DelayBehavior', function () {
+test('Debounce_Duration_DelayBehavior', function () {
     var results, scheduler, xs, ys;
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(
@@ -147,7 +147,7 @@ test('Throttle_Duration_DelayBehavior', function () {
     ];
 
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector((function (x) {
+        return xs.debounceWithSelector((function (x) {
             return ys[x];
         }));
     });
@@ -168,13 +168,13 @@ test('Throttle_Duration_DelayBehavior', function () {
     ys[4].subscriptions.assertEqual(subscribe(400, 400 + 20));
 });
 
-test('Throttle_Duration_ThrottleBehavior', function () {
+test('Debounce_Duration_DebounceBehavior', function () {
     var results, scheduler, xs, ys;
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(onNext(150, -1), onNext(250, 0), onNext(280, 1), onNext(310, 2), onNext(350, 3), onNext(400, 4), onCompleted(550));
     ys = [scheduler.createColdObservable(onNext(20, 42), onNext(25, 99)), scheduler.createColdObservable(onNext(40, 42), onNext(45, 99)), scheduler.createColdObservable(onNext(20, 42), onNext(25, 99)), scheduler.createColdObservable(onNext(60, 42), onNext(65, 99)), scheduler.createColdObservable(onNext(20, 42), onNext(25, 99))];
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function (x) {
+        return xs.debounceWithSelector(function (x) {
             return ys[x];
         });
     });
@@ -187,13 +187,13 @@ test('Throttle_Duration_ThrottleBehavior', function () {
     ys[4].subscriptions.assertEqual(subscribe(400, 400 + 20));
 });
 
-test('Throttle_Duration_EarlyCompletion', function () {
+test('Debounce_Duration_EarlyCompletion', function () {
     var results, scheduler, xs, ys;
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(onNext(150, -1), onNext(250, 0), onNext(280, 1), onNext(310, 2), onNext(350, 3), onNext(400, 4), onCompleted(410));
     ys = [scheduler.createColdObservable(onNext(20, 42), onNext(25, 99)), scheduler.createColdObservable(onNext(40, 42), onNext(45, 99)), scheduler.createColdObservable(onNext(20, 42), onNext(25, 99)), scheduler.createColdObservable(onNext(60, 42), onNext(65, 99)), scheduler.createColdObservable(onNext(20, 42), onNext(25, 99))];
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function (x) {
+        return xs.debounceWithSelector(function (x) {
             return ys[x];
         });
     });
@@ -206,13 +206,13 @@ test('Throttle_Duration_EarlyCompletion', function () {
     ys[4].subscriptions.assertEqual(subscribe(400, 410));
 });
 
-test('Throttle_Duration_InnerError', function () {
+test('Debounce_Duration_InnerError', function () {
     var ex, results, scheduler, xs;
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(onNext(150, 1), onNext(250, 2), onNext(350, 3), onNext(450, 4), onCompleted(550));
     ex = 'ex';
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function (x) {
+        return xs.debounceWithSelector(function (x) {
             if (x < 4) {
                 return scheduler.createColdObservable(onNext(x * 10, "Ignore"), onNext(x * 10 + 5, "Aargh!"));
             } else {
@@ -224,27 +224,27 @@ test('Throttle_Duration_InnerError', function () {
     xs.subscriptions.assertEqual(subscribe(200, 490));
 });
 
-test('Throttle_Duration_OuterError', function () {
+test('Debounce_Duration_OuterError', function () {
     var ex, results, scheduler, xs;
     ex = 'ex';
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(onNext(150, 1), onNext(250, 2), onNext(350, 3), onNext(450, 4), onError(460, ex));
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function (x) {
+        return xs.debounceWithSelector(function (x) {
             return scheduler.createColdObservable(onNext(x * 10, "Ignore"), onNext(x * 10 + 5, "Aargh!"));
         });
     });
     results.messages.assertEqual(onNext(250 + 2 * 10, 2), onNext(350 + 3 * 10, 3), onError(460, ex));
     xs.subscriptions.assertEqual(subscribe(200, 460));
 });
 
-test('Throttle_Duration_SelectorThrows', function () {
+test('Debounce_Duration_SelectorThrows', function () {
     var ex, results, scheduler, xs;
     ex = 'ex';
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(onNext(150, 1), onNext(250, 2), onNext(350, 3), onNext(450, 4), onCompleted(550));
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function (x) {
+        return xs.debounceWithSelector(function (x) {
             if (x < 4) {
                 return scheduler.createColdObservable(onNext(x * 10, "Ignore"), onNext(x * 10 + 5, "Aargh!"));
             } else {
@@ -256,25 +256,25 @@ test('Throttle_Duration_SelectorThrows', function () {
     xs.subscriptions.assertEqual(subscribe(200, 450));
 });
 
-test('Throttle_Duration_InnerDone_DelayBehavior', function () {
+test('Debounce_Duration_InnerDone_DelayBehavior', function () {
     var results, scheduler, xs;
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(onNext(150, 1), onNext(250, 2), onNext(350, 3), onNext(450, 4), onCompleted(550));
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function (x) {
+        return xs.debounceWithSelector(function (x) {
             return scheduler.createColdObservable(onCompleted(x * 10));
         });
     });
     results.messages.assertEqual(onNext(250 + 2 * 10, 2), onNext(350 + 3 * 10, 3), onNext(450 + 4 * 10, 4), onCompleted(550));
     xs.subscriptions.assertEqual(subscribe(200, 550));
 });
 
-test('Throttle_Duration_InnerDone_ThrottleBehavior', function () {
+test('Debounce_Duration_InnerDone_DebounceBehavior', function () {
     var results, scheduler, xs;
     scheduler = new TestScheduler();
     xs = scheduler.createHotObservable(onNext(150, 1), onNext(250, 2), onNext(280, 3), onNext(300, 4), onNext(400, 5), onNext(410, 6), onCompleted(550));
     results = scheduler.startWithCreate(function () {
-        return xs.throttleWithSelector(function (x) {
+        return xs.debounceWithSelector(function (x) {
             return scheduler.createColdObservable(onCompleted(x * 10));
         });
     });

tests/observable/throttlewithselector.js tests/observable/debouncewithselector.jstests/observable/throttlewithselector.js renamed to tests/observable/debouncewithselector.js

@@ -268,7 +268,7 @@
   <script src="observable/interval.js"></script>
   <script src="observable/delay.js"></script>
   <script src="observable/debounce.js"></script>
-  <script src="observable/throttlewithselector.js"></script>
+  <script src="observable/debouncewithselector.js"></script>
   <script src="observable/bufferwithtime.js"></script>
   <script src="observable/windowwithtime.js"></script>
   <script src="observable/timeinterval.js"></script>