feat(inspectTime): add inspectTime operator

RxJS 5's `sampleTime` operator deviated from expected Rx behavior, but has value, so we're moving it to be named `inspectTime`. BREAKING CHANGE: `sampleTime` is now `inspectTime`
ReactiveX · Dec 14, 2015 · 6835dcd · 6835dcd
1 parent f9944ae
commit 6835dcd
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 25 deletions.
diff --git a/spec/operators/sampleTime-spec.js → spec/operators/inspectTime-spec.js b/spec/operators/sampleTime-spec.js → spec/operators/inspectTime-spec.js
@@ -2,24 +2,24 @@
 var Rx = require('../../dist/cjs/Rx');
 var Observable = Rx.Observable;
 
-describe('Observable.prototype.sampleTime', function () {
-  it('should get samples on a delay', function () {
+describe('Observable.prototype.inspectTime', function () {
+  it('should get inspections on a delay', function () {
     var e1 =   hot('----a-^--b----c----d----e----f----|');
     var e1subs =         '^                           !';
     var expected =       '-----------c----------e-----|';
     // timer              -----------!----------!---------
 
-    expectObservable(e1.sampleTime(110, rxTestScheduler)).toBe(expected);
+    expectObservable(e1.inspectTime(110, rxTestScheduler)).toBe(expected);
     expectSubscriptions(e1.subscriptions).toBe(e1subs);
   });
 
-  it('should sample nothing if source has not nexted by time of sample', function () {
+  it('should inspect nothing if source has not nexted by time of inspect', function () {
     var e1 =   hot('----a-^-------------b-------------|');
     var e1subs =         '^                           !';
     var expected =       '----------------------b-----|';
     // timer              -----------!----------!---------
 
-    expectObservable(e1.sampleTime(110, rxTestScheduler)).toBe(expected);
+    expectObservable(e1.inspectTime(110, rxTestScheduler)).toBe(expected);
     expectSubscriptions(e1.subscriptions).toBe(e1subs);
   });
 
@@ -29,7 +29,7 @@ describe('Observable.prototype.sampleTime', function () {
     var expected =       '-----------c------#';
     // timer              -----------!----------!---------
 
-    expectObservable(e1.sampleTime(110, rxTestScheduler)).toBe(expected);
+    expectObservable(e1.inspectTime(110, rxTestScheduler)).toBe(expected);
     expectSubscriptions(e1.subscriptions).toBe(e1subs);
   });
 
@@ -40,7 +40,7 @@ describe('Observable.prototype.sampleTime', function () {
     var expected =       '-----------c-----            ';
     // timer              -----------!----------!---------
 
-    expectObservable(e1.sampleTime(110, rxTestScheduler), unsub).toBe(expected);
+    expectObservable(e1.inspectTime(110, rxTestScheduler), unsub).toBe(expected);
     expectSubscriptions(e1.subscriptions).toBe(e1subs);
   });
 
@@ -53,7 +53,7 @@ describe('Observable.prototype.sampleTime', function () {
 
     var result = e1
       .mergeMap(function (x) { return Observable.of(x); })
-      .sampleTime(110, rxTestScheduler)
+      .inspectTime(110, rxTestScheduler)
       .mergeMap(function (x) { return Observable.of(x); });
 
     expectObservable(result, unsub).toBe(expected);
@@ -65,7 +65,7 @@ describe('Observable.prototype.sampleTime', function () {
     var e1subs =   '(^!)';
     var expected = '|';
 
-    expectObservable(e1.sampleTime(60, rxTestScheduler)).toBe(expected);
+    expectObservable(e1.inspectTime(60, rxTestScheduler)).toBe(expected);
     expectSubscriptions(e1.subscriptions).toBe(e1subs);
   });
 
@@ -74,7 +74,7 @@ describe('Observable.prototype.sampleTime', function () {
     var e1subs =   '(^!)';
     var expected = '#';
 
-    expectObservable(e1.sampleTime(60, rxTestScheduler)).toBe(expected);
+    expectObservable(e1.inspectTime(60, rxTestScheduler)).toBe(expected);
     expectSubscriptions(e1.subscriptions).toBe(e1subs);
   });
 
@@ -83,7 +83,7 @@ describe('Observable.prototype.sampleTime', function () {
     var e1subs =   '^';
     var expected = '-';
 
-    expectObservable(e1.sampleTime(60, rxTestScheduler)).toBe(expected);
+    expectObservable(e1.inspectTime(60, rxTestScheduler)).toBe(expected);
     expectSubscriptions(e1.subscriptions).toBe(e1subs);
   });
 });
diff --git a/src/CoreOperators.ts b/src/CoreOperators.ts
@@ -40,6 +40,7 @@ export interface CoreOperators<T> {
                 durationSelector?: (group: GroupedObservable<R>) => Observable<any>) => Observable<GroupedObservable<R>>;
   ignoreElements?: () => Observable<T>;
   inspect?: (notifier: Observable<any>) => Observable<T>;
+  inspectTime?: (delay: number, scheduler?: Scheduler) => Observable<T>;
   last?: <R>(predicate?: (value: T, index: number) => boolean,
              resultSelector?: (value: T, index: number) => R,
              defaultValue?: any) => Observable<T> | Observable<R>;
@@ -63,7 +64,6 @@ export interface CoreOperators<T> {
   repeat?: (count?: number) => Observable<T>;
   retry?: (count?: number) => Observable<T>;
   retryWhen?: (notifier: (errors: Observable<any>) => Observable<any>) => Observable<T>;
-  sampleTime?: (delay: number, scheduler?: Scheduler) => Observable<T>;
   scan?: <R>(project: (acc: R, x: T) => R, acc?: R) => Observable<R>;
   share?: () => Observable<T>;
   single?: (predicate?: (value: T, index: number) => boolean) => Observable<T>;

diff --git a/src/Observable.ts b/src/Observable.ts
@@ -221,6 +221,7 @@ export class Observable<T> implements CoreOperators<T>  {
                durationSelector?: (group: GroupedObservable<R>) => Observable<any>) => Observable<GroupedObservable<R>>;
   ignoreElements: () => Observable<T>;
   inspect: (notifier: Observable<any>) => Observable<T>;
+  inspectTime: (delay: number, scheduler?: Scheduler) => Observable<T>;
   last: <R>(predicate?: (value: T, index: number) => boolean,
             resultSelector?: (value: T, index: number) => R,
             thisArg?: any, defaultValue?: any) => Observable<T> | Observable<R>;
@@ -245,7 +246,6 @@ export class Observable<T> implements CoreOperators<T>  {
   repeat: (count?: number) => Observable<T>;
   retry: (count?: number) => Observable<T>;
   retryWhen: (notifier: (errors: Observable<any>) => Observable<any>) => Observable<T>;
-  sampleTime: (delay: number, scheduler?: Scheduler) => Observable<T>;
   scan: <R>(accumulator: (acc: R, x: T) => R, seed?: T | R) => Observable<R>;
   share: () => Observable<T>;
   single: (predicate?: (value: T, index: number) => boolean) => Observable<T>;

diff --git a/src/Rx.KitchenSink.ts b/src/Rx.KitchenSink.ts
@@ -75,6 +75,7 @@ import './add/operator/first';
 import './add/operator/groupBy';
 import './add/operator/ignoreElements';
 import './add/operator/inspect';
+import './add/operator/inspectTime';
 import './add/operator/extended/isEmpty';
 import './add/operator/every';
 import './add/operator/last';
@@ -99,7 +100,6 @@ import './add/operator/reduce';
 import './add/operator/repeat';
 import './add/operator/retry';
 import './add/operator/retryWhen';
-import './add/operator/sampleTime';
 import './add/operator/scan';
 import './add/operator/share';
 import './add/operator/single';

diff --git a/src/Rx.ts b/src/Rx.ts
@@ -55,6 +55,7 @@ import './add/operator/first';
 import './add/operator/groupBy';
 import './add/operator/ignoreElements';
 import './add/operator/inspect';
+import './add/operator/inspectTime';
 import './add/operator/every';
 import './add/operator/last';
 import './add/operator/map';
@@ -75,7 +76,6 @@ import './add/operator/reduce';
 import './add/operator/repeat';
 import './add/operator/retry';
 import './add/operator/retryWhen';
-import './add/operator/sampleTime';
 import './add/operator/scan';
 import './add/operator/share';
 import './add/operator/single';

diff --git a/src/add/operator/inspectTime.ts b/src/add/operator/inspectTime.ts
@@ -0,0 +1,5 @@
+import {Observable} from '../../Observable';
+import {inspectTime} from '../../operator/inspectTime';
+Observable.prototype.inspectTime = inspectTime;
+
+export var _void: void;
diff --git a/src/add/operator/sampleTime.ts b/src/add/operator/sampleTime.ts
diff --git a/src/operator/sampleTime.ts → src/operator/inspectTime.ts b/src/operator/sampleTime.ts → src/operator/inspectTime.ts
@@ -4,20 +4,20 @@ import {Subscriber} from '../Subscriber';
 import {Scheduler} from '../Scheduler';
 import {asap} from '../scheduler/asap';
 
-export function sampleTime<T>(delay: number, scheduler: Scheduler = asap): Observable<T> {
-  return this.lift(new SampleTimeOperator(delay, scheduler));
+export function inspectTime<T>(delay: number, scheduler: Scheduler = asap): Observable<T> {
+  return this.lift(new InspectTimeOperator(delay, scheduler));
 }
 
-class SampleTimeOperator<T, R> implements Operator<T, R> {
+class InspectTimeOperator<T, R> implements Operator<T, R> {
   constructor(private delay: number, private scheduler: Scheduler) {
   }
 
   call(subscriber: Subscriber<R>) {
-    return new SampleTimeSubscriber(subscriber, this.delay, this.scheduler);
+    return new InspectTimeSubscriber(subscriber, this.delay, this.scheduler);
   }
 }
 
-class SampleTimeSubscriber<T> extends Subscriber<T> {
+class InspectTimeSubscriber<T> extends Subscriber<T> {
   lastValue: T;
   hasValue: boolean = false;