@thi.ng/transducers/rechunk.d.ts

Collection of ~170 lightweight, composable transducers, reducers, generators, iterators for functional data transformations

import type { Transducer } from "./api.js";
/**
 * Stateful transducer to rechunk/split strings using optional provided regexp
 * (or using `/\r?\n/` (line breaks) by default).
 *
 * @remarks
 * Each incoming string is appended to current buffer string, which is then
 * split using the regexp and re-emitted to as new chunks.
 *
 * One of the main use cases for this transducer is to work in conjunction with
 * NodeJS' stream processing.
 *
 * @example
 * ```ts tangle:../export/rechunk.ts
 * import { rechunk } from "@thi.ng/transducers";
 *
 * console.log(
 *   [...rechunk(/-/, ["abc-d", "ef-g-", "hij", "-k-lm"])]
 * );
 * // [ "abc", "def", "g", "hij", "k", "lm" ]
 * ```
 *
 * @example
 * ```ts tangle:../export/rechunk-2.ts
 * import { fromNodeJS, trace } from "@thi.ng/rstream";
 * import { rechunk } from "@thi.ng/transducers";
 * import { spawn } from "node:child_process"
 *
 * const cmd = spawn("ls", ["-la"]);
 *
 * // (btw. also see linesFromNodeJS() for automatic rechunking)
 * fromNodeJS<string>(cmd.stdout, cmd.stderr)
 *   .transform(rechunk())
 *   .subscribe(trace("output"));
 *
 * // output total 12760
 * // output drwxr-xr-x   37 foo  staff     1184 Nov 15 15:29 .
 * // output drwxr-xr-x  143 foo  staff     4576 Nov 11 21:08 ..
 * // output drwxr-xr-x   17 foo  staff      544 Nov 15 17:39 .git
 * // output -rw-r--r--    1 foo  staff      149 Aug  4 15:32 .gitattributes
 * // output drwxr-xr-x    5 foo  staff      160 Apr 12  2021 .github
 * // output -rw-r--r--    1 foo  staff      659 Sep 10 22:55 .gitignore
 * // ...
 * // output done
 * ```
 *
 * @param re -
 */
export declare function rechunk(re?: RegExp): Transducer<string, string>;
export declare function rechunk(src: Iterable<string>): IterableIterator<string>;
export declare function rechunk(re: RegExp, src: Iterable<string>): IterableIterator<string>;
//# sourceMappingURL=rechunk.d.ts.map