UNPKG

1.57 kBTypeScriptView Raw
1import { ObservableInput, OperatorFunction } from '../types';
2/**
3 * Buffers the source Observable values, using a factory function of closing
4 * Observables to determine when to close, emit, and reset the buffer.
5 *
6 * <span class="informal">Collects values from the past as an array. When it
7 * starts collecting values, it calls a function that returns an Observable that
8 * tells when to close the buffer and restart collecting.</span>
9 *
10 * ![](bufferWhen.svg)
11 *
12 * Opens a buffer immediately, then closes the buffer when the observable
13 * returned by calling `closingSelector` function emits a value. When it closes
14 * the buffer, it immediately opens a new buffer and repeats the process.
15 *
16 * ## Example
17 *
18 * Emit an array of the last clicks every [1-5] random seconds
19 *
20 * ```ts
21 * import { fromEvent, bufferWhen, interval } from 'rxjs';
22 *
23 * const clicks = fromEvent(document, 'click');
24 * const buffered = clicks.pipe(
25 * bufferWhen(() => interval(1000 + Math.random() * 4000))
26 * );
27 * buffered.subscribe(x => console.log(x));
28 * ```
29 *
30 * @see {@link buffer}
31 * @see {@link bufferCount}
32 * @see {@link bufferTime}
33 * @see {@link bufferToggle}
34 * @see {@link windowWhen}
35 *
36 * @param {function(): Observable} closingSelector A function that takes no
37 * arguments and returns an Observable that signals buffer closure.
38 * @return A function that returns an Observable of arrays of buffered values.
39 */
40export declare function bufferWhen<T>(closingSelector: () => ObservableInput<any>): OperatorFunction<T, T[]>;
41//# sourceMappingURL=bufferWhen.d.ts.map
\No newline at end of file