diff --git a/src/operator/first.ts b/src/operator/first.ts index cb6d09baf4..8f7529b841 100644 --- a/src/operator/first.ts +++ b/src/operator/first.ts @@ -1,7 +1,5 @@ import { Observable } from '../Observable'; -import { Operator } from '../Operator'; -import { Subscriber } from '../Subscriber'; -import { EmptyError } from '../util/EmptyError'; +import { first as higherOrder } from '../operators'; /* tslint:disable:max-line-length */ export function first(this: Observable, @@ -76,97 +74,5 @@ export function first(this: Observable, export function first(this: Observable, predicate?: (value: T, index: number, source: Observable) => boolean, resultSelector?: ((value: T, index: number) => R) | void, defaultValue?: R): Observable { - return this.lift(new FirstOperator(predicate, resultSelector, defaultValue, this)); -} - -class FirstOperator implements Operator { - constructor(private predicate?: (value: T, index: number, source: Observable) => boolean, - private resultSelector?: ((value: T, index: number) => R) | void, - private defaultValue?: any, - private source?: Observable) { - } - - call(observer: Subscriber, source: any): any { - return source.subscribe(new FirstSubscriber(observer, this.predicate, this.resultSelector, this.defaultValue, this.source)); - } -} - -/** - * We need this JSDoc comment for affecting ESDoc. - * @ignore - * @extends {Ignored} - */ -class FirstSubscriber extends Subscriber { - private index: number = 0; - private hasCompleted: boolean = false; - private _emitted: boolean = false; - - constructor(destination: Subscriber, - private predicate?: (value: T, index: number, source: Observable) => boolean, - private resultSelector?: ((value: T, index: number) => R) | void, - private defaultValue?: any, - private source?: Observable) { - super(destination); - } - - protected _next(value: T): void { - const index = this.index++; - if (this.predicate) { - this._tryPredicate(value, index); - } else { - this._emit(value, index); - } - } - - private _tryPredicate(value: T, index: number) { - let result: any; - try { - result = this.predicate(value, index, this.source); - } catch (err) { - this.destination.error(err); - return; - } - if (result) { - this._emit(value, index); - } - } - - private _emit(value: any, index: number) { - if (this.resultSelector) { - this._tryResultSelector(value, index); - return; - } - this._emitFinal(value); - } - - private _tryResultSelector(value: T, index: number) { - let result: any; - try { - result = (this).resultSelector(value, index); - } catch (err) { - this.destination.error(err); - return; - } - this._emitFinal(result); - } - - private _emitFinal(value: any) { - const destination = this.destination; - if (!this._emitted) { - this._emitted = true; - destination.next(value); - destination.complete(); - this.hasCompleted = true; - } - } - - protected _complete(): void { - const destination = this.destination; - if (!this.hasCompleted && typeof this.defaultValue !== 'undefined') { - destination.next(this.defaultValue); - destination.complete(); - } else if (!this.hasCompleted) { - destination.error(new EmptyError); - } - } + return higherOrder(predicate, resultSelector as any, defaultValue)(this); } diff --git a/src/operators/first.ts b/src/operators/first.ts new file mode 100644 index 0000000000..263b2ded40 --- /dev/null +++ b/src/operators/first.ts @@ -0,0 +1,166 @@ +import { Observable } from '../Observable'; +import { Operator } from '../Operator'; +import { Subscriber } from '../Subscriber'; +import { EmptyError } from '../util/EmptyError'; +import { OperatorFunction, MonoTypeOperatorFunction } from '../interfaces'; +/* tslint:disable:max-line-length */ +export function first(predicate: (value: T, index: number, source: Observable) => value is S): OperatorFunction; +export function first(predicate: (value: T | S, index: number, source: Observable) => value is S, + resultSelector: (value: S, index: number) => R, defaultValue?: R): OperatorFunction; +export function first(predicate: (value: T, index: number, source: Observable) => value is S, + resultSelector: void, + defaultValue?: S): OperatorFunction; +export function first(predicate?: (value: T, index: number, source: Observable) => boolean): MonoTypeOperatorFunction; +export function first(predicate: (value: T, index: number, source: Observable) => boolean, + resultSelector?: (value: T, index: number) => R, + defaultValue?: R): OperatorFunction; +export function first(predicate: (value: T, index: number, source: Observable) => boolean, + resultSelector: void, + defaultValue?: T): MonoTypeOperatorFunction; + +/** + * Emits only the first value (or the first value that meets some condition) + * emitted by the source Observable. + * + * Emits only the first value. Or emits only the first + * value that passes some test. + * + * + * + * If called with no arguments, `first` emits the first value of the source + * Observable, then completes. If called with a `predicate` function, `first` + * emits the first value of the source that matches the specified condition. It + * may also take a `resultSelector` function to produce the output value from + * the input value, and a `defaultValue` to emit in case the source completes + * before it is able to emit a valid value. Throws an error if `defaultValue` + * was not provided and a matching element is not found. + * + * @example Emit only the first click that happens on the DOM + * var clicks = Rx.Observable.fromEvent(document, 'click'); + * var result = clicks.first(); + * result.subscribe(x => console.log(x)); + * + * @example Emits the first click that happens on a DIV + * var clicks = Rx.Observable.fromEvent(document, 'click'); + * var result = clicks.first(ev => ev.target.tagName === 'DIV'); + * result.subscribe(x => console.log(x)); + * + * @see {@link filter} + * @see {@link find} + * @see {@link take} + * + * @throws {EmptyError} Delivers an EmptyError to the Observer's `error` + * callback if the Observable completes before any `next` notification was sent. + * + * @param {function(value: T, index: number, source: Observable): boolean} [predicate] + * An optional function called with each item to test for condition matching. + * @param {function(value: T, index: number): R} [resultSelector] A function to + * produce the value on the output Observable based on the values + * and the indices of the source Observable. The arguments passed to this + * function are: + * - `value`: the value that was emitted on the source. + * - `index`: the "index" of the value from the source. + * @param {R} [defaultValue] The default value emitted in case no valid value + * was found on the source. + * @return {Observable} An Observable of the first item that matches the + * condition. + * @method first + * @owner Observable + */ +export function first(predicate?: (value: T, index: number, source: Observable) => boolean, + resultSelector?: ((value: T, index: number) => R) | void, + defaultValue?: R): OperatorFunction { + return (source: Observable) => source.lift(new FirstOperator(predicate, resultSelector, defaultValue, source)); +} + +class FirstOperator implements Operator { + constructor(private predicate?: (value: T, index: number, source: Observable) => boolean, + private resultSelector?: ((value: T, index: number) => R) | void, + private defaultValue?: any, + private source?: Observable) { + } + + call(observer: Subscriber, source: any): any { + return source.subscribe(new FirstSubscriber(observer, this.predicate, this.resultSelector, this.defaultValue, this.source)); + } +} + +/** + * We need this JSDoc comment for affecting ESDoc. + * @ignore + * @extends {Ignored} + */ +class FirstSubscriber extends Subscriber { + private index: number = 0; + private hasCompleted: boolean = false; + private _emitted: boolean = false; + + constructor(destination: Subscriber, + private predicate?: (value: T, index: number, source: Observable) => boolean, + private resultSelector?: ((value: T, index: number) => R) | void, + private defaultValue?: any, + private source?: Observable) { + super(destination); + } + + protected _next(value: T): void { + const index = this.index++; + if (this.predicate) { + this._tryPredicate(value, index); + } else { + this._emit(value, index); + } + } + + private _tryPredicate(value: T, index: number) { + let result: any; + try { + result = this.predicate(value, index, this.source); + } catch (err) { + this.destination.error(err); + return; + } + if (result) { + this._emit(value, index); + } + } + + private _emit(value: any, index: number) { + if (this.resultSelector) { + this._tryResultSelector(value, index); + return; + } + this._emitFinal(value); + } + + private _tryResultSelector(value: T, index: number) { + let result: any; + try { + result = (this).resultSelector(value, index); + } catch (err) { + this.destination.error(err); + return; + } + this._emitFinal(result); + } + + private _emitFinal(value: any) { + const destination = this.destination; + if (!this._emitted) { + this._emitted = true; + destination.next(value); + destination.complete(); + this.hasCompleted = true; + } + } + + protected _complete(): void { + const destination = this.destination; + if (!this.hasCompleted && typeof this.defaultValue !== 'undefined') { + destination.next(this.defaultValue); + destination.complete(); + } else if (!this.hasCompleted) { + destination.error(new EmptyError); + } + } +} diff --git a/src/operators/index.ts b/src/operators/index.ts index e13926fee0..2921296c4e 100644 --- a/src/operators/index.ts +++ b/src/operators/index.ts @@ -28,6 +28,7 @@ export { filter } from './filter'; export { finalize } from './finalize'; export { find } from './find'; export { findIndex } from './findIndex'; +export { first } from './first'; export { ignoreElements } from './ignoreElements'; export { map } from './map'; export { materialize } from './materialize';