timeoutWith

Ocurre un error si el Observable no emite ningún valor antes de que transcurra un intervalo de tiempo, en cuyo caso se suscribe al segundo Observable

Signatura

Firma

timeoutWith<T, R>(due: number | Date, withObservable: any, scheduler: SchedulerLike = async): OperatorFunction<T, T | R>

Parámetros

Retorna

OperatorFunction<T, T | R>: Un Observable que refleja el comportamiento de la fuente o, cuando no supera la comprobación del timeout, de un segundo Observable proporcionado por parámetros.

Descripción

Es una versión del operador timeout que permite especificar un Observable comodín.

timeoutWith es una variante del operador timeout. Se comporta exactamente igual, recibe como primer argumento un número o una fecha, que controlan cuándo se deben emitir los valores del Observable fuente o cuando debe completarse, respectivamente.

La única diferencia es que recibe un segundo parámetro obligatorio. Este parámetro debe ser un Observable que será suscrito cuando el Observable fuente no supere cualquiera de las comprobaciones de timeout. Por tanto, donde el operador timeout emite un error, timeoutWith empieza a emitir valores de un segundo Observable. Se debe tener en cuenta que no se realizan comprobaciones de timeout al Observable comodín, por lo que este puede emitir valores y completarse en cualquier momento. Desde el momento en el que ocurre la segunda suscripción, el Observable retornado por timeoutWith se limita a reflejar el Observable comodín. Cuando el flujo comodín se complete, también lo hará el Observable retornado por timeoutWith.

También se puede proporcionar un Planificador como tercer argumento opcional, que en el caso del operador timeout se proporciona como segundo argumento. Se utiliza para planificar las comprobaciones de timeout, y en consecuencia, cuándo se realizará la suscripción al segundo Observable, ya que la suscripción ocurre inmediatamente después de una comprobación no superada.

Ejemplos

Emitir una secuencia de números si no se presiona ninguna tecla en 5s

StackBlitz

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

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

const number = interval(1000);

key$
  .pipe(
    map(({ code }) => code),
    timeoutWith(5000, number)
  )
  .subscribe(console.log, console.error);
// Salida: (Presionar tecla) KeyX (5s) 0, 1, 2, 3, 4...

Emitir un mensaje en caso de que ocurra el timeout de una petición

StackBlitz

import { of } from "rxjs";
import { concatMap, timeoutWith, delay, map } from "rxjs/operators";
import { ajax } from "rxjs/ajax";

function getPokemonName(time: number) {
  return ajax.getJSON("https://pokeapi.co/api/v2/pokemon/4").pipe(
    map(({ name }) => name),
    delay(time)
  );
}

const delay$ = of(5000, 4000, 2000);

delay$
  .pipe(
    concatMap((delay) =>
      getPokemonName(delay).pipe(
        timeoutWith(3000, of("Ha ocurrido un timeout"))
      )
    )
  )
  .subscribe(console.log);
// Salida: 'Ha ocurrido un timeout', 'Ha ocurrido un timeout', 'charmander'

Ejemplo de la documentación oficial

Proporcionar un Observable comodín

import { interval } from "rxjs";
import { timeoutWith } from "rxjs/operators";

const seconds = interval(1000);
const minutes = interval(60 * 1000);

seconds.pipe(timeoutWith(900, minutes)).subscribe(
  (value) => console.log(value), // After 900ms, will start emitting `minutes`,
  // since first value of `seconds` will not arrive fast enough.
  (err) => console.log(err) // Would be called after 900ms in case of `timeout`,
  // but here will never be called.
);

Recursos adicionales

Documentación oficial en inglés