stream-chain/src/core/index.d.ts

Chain functions, generators, Node streams, and Web streams into a pipeline with backpressure support.

import type {Arg0, Ret} from '../defs.js';

export interface CoreChainOptions {}

/**
 * The /core chain output: a callable async-iterable factory.
 * Calling it with an iterable yields each value through the composed function pipeline.
 *
 * Property surface (`streams` / `input` / `output`) is intentionally `null` here for
 * parity with `/node`'s `ChainOutput` and `/web`'s `ChainWebStream` — same property
 * names, substrate-specific values (or `null` when there's no substrate).
 */
export interface CoreChainOutput<W, R> {
  (input?: AsyncIterable<W> | Iterable<W>): AsyncGenerator<R, void, unknown>;
  readonly streams: null;
  readonly input: null;
  readonly output: null;
}

/**
 * Creates a function-list-driven chain that runs purely on async iteration —
 * no Node streams, no Web Streams. Browser-safe.
 *
 * Only `fun(...)` / `gen(...)` operators (and plain functions) are accepted; passing
 * `asStream(...)` or `asWebStream(...)` items is unsupported in `/core`.
 *
 * @param fns array of functions, `fun(...)` wrappers, `gen(...)` wrappers, or nested arrays
 * @returns a callable async-iterable factory with null stream-shape statics
 */
/**
 * `/core` chain factory. Composes functions / `fun(...)` / `gen(...)` into a
 * callable async-iterable factory; no Node streams or Web Streams involved.
 * @param fns array of functions, `fun(...)`/`gen(...)` wrappers, or nested arrays (flattened). Falsy items are ignored. Passing an actual stream object is unsupported in `/core`.
 * @param options optional configuration object. Currently no recognized fields — reserved for future use ({@link CoreChainOptions} is intentionally empty).
 * @returns a callable async-iterable factory: `(input?) => AsyncGenerator<R>`. Calling it with an iterable runs each value through the composed pipeline.
 */
declare function chain<const L extends readonly unknown[]>(
  fns: L,
  options?: CoreChainOptions
): CoreChainOutput<Arg0<L>, Ret<L>>;

/**
 * Same as {@link chain} but bypasses TypeScript type checking on `fns`.
 * @param fns array of functions and wrappers. Type checking is intentionally not applied.
 * @param options optional configuration object — see {@link CoreChainOptions}.
 * @returns a callable async-iterable factory typed as `CoreChainOutput<W, R>` (caller-supplied type parameters).
 */
declare function chainUnchecked<W = any, R = any>(
  fns: readonly any[],
  options?: CoreChainOptions
): CoreChainOutput<W, R>;

export default chain;
export {chain, chainUnchecked};
export {gen} from '../gen.js';
export {fun} from '../fun.js';
export {dataSource} from '../dataSource.js';
export * from '../defs.js';