windowWhen

Acumula valores del Observable fuente en un Observable anidado (ventana), utilizando una función factoría de Observables para determinar cuándo abrir una nueva ventana

Signatura

Firma

windowWhen<T>(closingSelector: () => Observable<any>): OperatorFunction<T, Observable<T>>

Parámetros

closingSelector

Una función que no recibe ningún argumento y retorna un Observable que indica (con una notificación next o complete) cuándo cerrar la ventana actual y abrir una nueva.

Retorna

OperatorFunction<T, Observable<T>>: Un Observable de ventanas, que son Observables de valores.

Descripción

Es como bufferWhen, pero emite un Observable anidado en lugar de un array.

Retorna un Observable que emite ventanas de elementos que recoge del Observable fuente. El Observable resultante emite ventanas conectas, sin superposición. Emite la ventana actual y abre una ventana nueva cuando el Observable retornado por la función closingSelector emita un valor. La primera ventana se abre inmediatamente después de llevar a cabo la suscripción al Observable resultante.

Ejemplos

Recoger una secuencia ascendente de números en una ventana. Cada vez que se haga click, abrir una nueva ventana

StackBlitz

import { fromEvent, interval } from "rxjs";
import { windowWhen, mergeAll, tap } from "rxjs/operators";

const number$ = interval(2000);

number$
  .pipe(
    windowWhen(() => fromEvent<KeyboardEvent>(document, "click")),
    tap((_) => console.log("Nueva ventana")),
    mergeAll()
  )
  .subscribe(console.log);
// Salida: Nueva ventana, 0, 1, 2, 3 (click) Nueva ventana, 4, 5, 6...

Recoger teclas pulsadas en una ventana de duración aleatoria de entre 1 y 4 segundos

StackBlitz

import { fromEvent, interval } from "rxjs";
import { windowWhen, mergeAll, tap, map } from "rxjs/operators";

const key$ = fromEvent<KeyboardEvent>(document, "keydown");

key$
  .pipe(
    map(({ code }) => code),
    windowWhen(() => interval(1000 + Math.random() * 3000)),
    tap((_) => console.log("Nueva ventana")),
    // Transformando el Observable de orden superior en uno de primer orden
    mergeAll()
  )
  .subscribe(console.log);
// Salida: Nueva ventana, KeyR, KeyX (x segundos aleatorios después) Nueva ventana, KeyJ, KeyS...

Ejemplo de la documentación oficial

Emitir únicamente los dos primeros eventos click en cada ventana de una duración aleatoria de entre 1 y 5 segundos

import { fromEvent, interval } from 'rxjs';
import { windowWhen, map, mergeAll, take } from 'rxjs/operators';

const clicks = fromEvent(document, 'click');
const result = clicks.pipe(
windowWhen(() => interval(1000 + Math.random() \* 4000)),
map(win => win.pipe(take(2))), // Cada ventana contiene como mucho 2 emisiones
mergeAll() // 'Aplastar' el Observable de Observables
);
result.subscribe(x => console.log(x));

Documentación oficial en inglés