45 lines
1.9 KiB
JavaScript
45 lines
1.9 KiB
JavaScript
|
import { filter as higherOrderFilter } from '../operators/filter';
|
||
|
/* tslint:enable:max-line-length */
|
||
|
/**
|
||
|
* Filter items emitted by the source Observable by only emitting those that
|
||
|
* satisfy a specified predicate.
|
||
|
*
|
||
|
* <span class="informal">Like
|
||
|
* [Array.prototype.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter),
|
||
|
* it only emits a value from the source if it passes a criterion function.</span>
|
||
|
*
|
||
|
* <img src="./img/filter.png" width="100%">
|
||
|
*
|
||
|
* Similar to the well-known `Array.prototype.filter` method, this operator
|
||
|
* takes values from the source Observable, passes them through a `predicate`
|
||
|
* function and only emits those values that yielded `true`.
|
||
|
*
|
||
|
* @example <caption>Emit only click events whose target was a DIV element</caption>
|
||
|
* var clicks = Rx.Observable.fromEvent(document, 'click');
|
||
|
* var clicksOnDivs = clicks.filter(ev => ev.target.tagName === 'DIV');
|
||
|
* clicksOnDivs.subscribe(x => console.log(x));
|
||
|
*
|
||
|
* @see {@link distinct}
|
||
|
* @see {@link distinctUntilChanged}
|
||
|
* @see {@link distinctUntilKeyChanged}
|
||
|
* @see {@link ignoreElements}
|
||
|
* @see {@link partition}
|
||
|
* @see {@link skip}
|
||
|
*
|
||
|
* @param {function(value: T, index: number): boolean} predicate A function that
|
||
|
* evaluates each value emitted by the source Observable. If it returns `true`,
|
||
|
* the value is emitted, if `false` the value is not passed to the output
|
||
|
* Observable. The `index` parameter is the number `i` for the i-th source
|
||
|
* emission that has happened since the subscription, starting from the number
|
||
|
* `0`.
|
||
|
* @param {any} [thisArg] An optional argument to determine the value of `this`
|
||
|
* in the `predicate` function.
|
||
|
* @return {Observable} An Observable of values from the source that were
|
||
|
* allowed by the `predicate` function.
|
||
|
* @method filter
|
||
|
* @owner Observable
|
||
|
*/
|
||
|
export function filter(predicate, thisArg) {
|
||
|
return higherOrderFilter(predicate, thisArg)(this);
|
||
|
}
|
||
|
//# sourceMappingURL=filter.js.map
|