scan

Aplica una función acumuladora a los valores del Observable fuente y retorna cada resultado inmediato

💡 Si solo se necesita emitir el valor acumulado una vez que el Observable se haya completado, se puede utilizar reduce

Signatura

Firma

scan<T, R>(accumulator: (acc: R, value: T, index: number) => R, seed?: T | R): OperatorFunction<T, R>

Parámetros

accumulator	La función de acumulación que se aplica a cada valor emitido.
seed	Opcional. El valor por defecto es undefined. El valor de acumulación inicial.

Retorna

OperatorFunction<T, R>: Un Observable de valores acumulados.

Descripción

Es como reduce, pero emite el valor acumulado cada vez que la fuente emite un valor.

Combina todos los valores emitidos por la fuente, mediante una función de acumulación. Es similar al operador reduce, pero emite cada valor acumulado.

Retorna un Observable que aplica una función de acumulación a cada elemento emitido por el Observable fuente. Si se proporciona un valor seed, ese valor se utilizará como el valor inicial del acumulador. Si no se proporciona ningún valor inicial, se utilizará el primer elemento emitido por la fuente en su lugar.

Ejemplos

Sumar una secuencia de números

StackBlitz

import { scan } from "rxjs/operators";
import { range } from "rxjs";

const number$ = range(1, 10);

number$.pipe(scan((acc, val) => acc + val)).subscribe(console.log);
// Salida: 1, 3, 6, 10, 15, 21, 28, 36, 45, 55

Sumar una secuencia de números proporcionando un valor inicial

StackBlitz

import { scan } from "rxjs/operators";
import { range } from "rxjs";

const number$ = range(1, 10);

number$.pipe(scan((acc, val) => acc + val, 10)).subscribe(console.log);
// Salida: 11, 13, 16, 20, 25, 31, 38, 46, 55, 65

Concatenar una secuencia de cadenas

StackBlitz

import { scan } from "rxjs/operators";
import { from } from "rxjs";

const letter$ = from(["R", "x", "J", "S", " ", "m", "o", "l", "a"]);

letter$.pipe(scan((acc, val) => acc + val)).subscribe(console.log);
/*Salida: R
          Rx
          RxJ
          RxJS
          RxJS 
          RxJS m
          RxJS mo
          RxJS mol 
          RxJS mola
*/

Ejemplo de la documentación oficial

Contar el número de eventos click

import { fromEvent } from "rxjs";
import { scan, mapTo } from "rxjs/operators";

const clicks = fromEvent(document, "click");
const ones = clicks.pipe(mapTo(1));
const seed = 0;
const count = ones.pipe(scan((acc, one) => acc + one, seed));
count.subscribe((x) => console.log(x));

Sobrecargas

Firma

scan(accumulator: (acc: R, value: T, index: number) => R, seed: R): OperatorFunction<T, R>

Parámetros

accumulator	Tipo: (acc: R, value: T, index: number) => R.
seed	Tipo: R.

Retorna

OperatorFunction<T, R>

Firma

scan(accumulator: (acc: T, value: T, index: number) => T, seed?: T): MonoTypeOperatorFunction<T>

Parámetros

accumulator	Tipo: (acc: T, value: T, index: number) => T.
seed	Opcional. El valor por defecto es undefined. Tipo: T.

Retorna

MonoTypeOperatorFunction<T>

Firma

scan(accumulator: (acc: R, value: T, index: number) => R): OperatorFunction<T, R>

Parámetros

accumulator

Tipo: (acc: R, value: T, index: number) => R.

Retorna

OperatorFunction<T, R>

Documentación oficial en inglés