1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- /** PURE_IMPORTS_START .._operators_sequenceEqual PURE_IMPORTS_END */
- import { sequenceEqual as higherOrder } from '../operators/sequenceEqual';
- /**
- * Compares all values of two observables in sequence using an optional comparor function
- * and returns an observable of a single boolean value representing whether or not the two sequences
- * are equal.
- *
- * <span class="informal">Checks to see of all values emitted by both observables are equal, in order.</span>
- *
- * <img src="./img/sequenceEqual.png" width="100%">
- *
- * `sequenceEqual` subscribes to two observables and buffers incoming values from each observable. Whenever either
- * observable emits a value, the value is buffered and the buffers are shifted and compared from the bottom
- * up; If any value pair doesn't match, the returned observable will emit `false` and complete. If one of the
- * observables completes, the operator will wait for the other observable to complete; If the other
- * observable emits before completing, the returned observable will emit `false` and complete. If one observable never
- * completes or emits after the other complets, the returned observable will never complete.
- *
- * @example <caption>figure out if the Konami code matches</caption>
- * var code = Rx.Observable.from([
- * "ArrowUp",
- * "ArrowUp",
- * "ArrowDown",
- * "ArrowDown",
- * "ArrowLeft",
- * "ArrowRight",
- * "ArrowLeft",
- * "ArrowRight",
- * "KeyB",
- * "KeyA",
- * "Enter" // no start key, clearly.
- * ]);
- *
- * var keys = Rx.Observable.fromEvent(document, 'keyup')
- * .map(e => e.code);
- * var matches = keys.bufferCount(11, 1)
- * .mergeMap(
- * last11 =>
- * Rx.Observable.from(last11)
- * .sequenceEqual(code)
- * );
- * matches.subscribe(matched => console.log('Successful cheat at Contra? ', matched));
- *
- * @see {@link combineLatest}
- * @see {@link zip}
- * @see {@link withLatestFrom}
- *
- * @param {Observable} compareTo The observable sequence to compare the source sequence to.
- * @param {function} [comparor] An optional function to compare each value pair
- * @return {Observable} An Observable of a single boolean value representing whether or not
- * the values emitted by both observables were equal in sequence.
- * @method sequenceEqual
- * @owner Observable
- */
- export function sequenceEqual(compareTo, comparor) {
- return higherOrder(compareTo, comparor)(this);
- }
- //# sourceMappingURL=sequenceEqual.js.map
|