Sha256: cf86b3b87bd9923fe07289cbc0ebdaceea30e930aa8e90e267c4a70aad6bd60e
Contents?: true
Size: 1.44 KB
Versions: 49
Compression:
Stored size: 1.44 KB
Contents
import { Observable } from '../Observable';
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<T>(this: Observable<T>, closingNotifier: Observable<any>): Observable<T[]> {
return higherOrder(closingNotifier)(this) as Observable<T[]>;
}
Version data entries
49 entries across 49 versions & 4 rubygems