39 lines
1.4 KiB
JavaScript
39 lines
1.4 KiB
JavaScript
|
/** PURE_IMPORTS_START .._operators_buffer PURE_IMPORTS_END */
|
||
|
|
import { buffer as higherOrder } from '../operators/buffer';
|
||
|
|
/**
|
||
|
|
* Buffers the source Observable values until `closingNotifier` emits.
|
||
|
|
*
|
||
|
|
* <span class="informal">Collects values from the past as an array, and emits
|
||
|
|
* that array only when another Observable emits.</span>
|
||
|
|
*
|
||
|
|
* <img src="./img/buffer.png" width="100%">
|
||
|
|
*
|
||
|
|
* Buffers the incoming Observable values until the given `closingNotifier`
|
||
|
|
* Observable emits a value, at which point it emits the buffer on the output
|
||
|
|
* Observable and starts a new buffer internally, awaiting the next time
|
||
|
|
* `closingNotifier` emits.
|
||
|
|
*
|
||
|
|
* @example <caption>On every click, emit array of most recent interval events</caption>
|
||
|
|
* var clicks = Rx.Observable.fromEvent(document, 'click');
|
||
|
|
* var interval = Rx.Observable.interval(1000);
|
||
|
|
* var buffered = interval.buffer(clicks);
|
||
|
|
* buffered.subscribe(x => console.log(x));
|
||
|
|
*
|
||
|
|
* @see {@link bufferCount}
|
||
|
|
* @see {@link bufferTime}
|
||
|
|
* @see {@link bufferToggle}
|
||
|
|
* @see {@link bufferWhen}
|
||
|
|
* @see {@link window}
|
||
|
|
*
|
||
|
|
* @param {Observable<any>} closingNotifier An Observable that signals the
|
||
|
|
* buffer to be emitted on the output Observable.
|
||
|
|
* @return {Observable<T[]>} An Observable of buffers, which are arrays of
|
||
|
|
* values.
|
||
|
|
* @method buffer
|
||
|
|
* @owner Observable
|
||
|
|
*/
|
||
|
|
export function buffer(closingNotifier) {
|
||
|
|
return higherOrder(closingNotifier)(this);
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=buffer.js.map
|