ix/asynciterable/operators/scan.d.ts

The Interactive Extensions for JavaScript

import { AsyncIterableX } from '../asynciterablex.js';
import { OperatorAsyncFunction } from '../../interfaces.js';
import { ScanOptions } from './scanoptions.js';
/** @ignore */
export declare class ScanAsyncIterable<T, R> extends AsyncIterableX<R> {
    private _source;
    private _fn;
    private _seed?;
    private _hasSeed;
    constructor(source: AsyncIterable<T>, options: ScanOptions<T, R>);
    [Symbol.asyncIterator](signal?: AbortSignal): AsyncGenerator<Awaited<R>, void, unknown>;
}
/**
 * Applies an accumulator function over an async-iterable sequence and returns each intermediate result.
 * The specified seed value, if given, is used as the initial accumulator value.
 *
 * @template T The type of the elements in the source sequence.
 * @template R The type of the result of the aggregation.
 * @param {ScanOptions<T, R>} options The options including the accumulator function and seed.
 * @returns {OperatorAsyncFunction<T, R>} An async-enumerable sequence containing the accumulated values.
 */
export declare function scan<T, R = T>(options: ScanOptions<T, R>): OperatorAsyncFunction<T, R>;