44 lines
1.4 KiB
TypeScript
44 lines
1.4 KiB
TypeScript
|
import { Observable } from '../Observable';
|
||
|
|
import { OperatorFunction } from '../types';
|
||
|
|
/**
|
||
|
|
* 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>
|
||
|
|
*
|
||
|
|
* 
|
||
|
|
*
|
||
|
|
* 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
|
||
|
|
*
|
||
|
|
* On every click, emit array of most recent interval events
|
||
|
|
*
|
||
|
|
* ```ts
|
||
|
|
* import { fromEvent, interval } from 'rxjs';
|
||
|
|
* import { buffer } from 'rxjs/operators';
|
||
|
|
*
|
||
|
|
* const clicks = fromEvent(document, 'click');
|
||
|
|
* const intervalEvents = interval(1000);
|
||
|
|
* const buffered = intervalEvents.pipe(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 declare function buffer<T>(closingNotifier: Observable<any>): OperatorFunction<T, T[]>;
|