@@ -63,18 +63,19 @@ wiki/ # GitHub wiki documentation (git submodule)
6363
6464Functions in a chain can return special values to control flow:
6565
66- | Value | Symbol | Effect |
67- | -------| --------| --------|
68- | ` none ` | ` object-stream.none ` | Skip — no value passed downstream |
69- | ` null ` /` undefined ` | — | Same as ` none ` |
70- | ` stop ` | ` object-stream.stop ` | Skip and terminate the generator (gen/fun only) |
71- | ` many(values) ` | ` object-stream.many ` | Emit multiple values from a single input |
66+ | Value | Symbol | Effect |
67+ | ------------------- | --------------------- | -------------------------------------------------------------- |
68+ | ` none ` | ` object-stream.none ` | Skip — no value passed downstream |
69+ | ` null ` /` undefined ` | — | Same as ` none ` |
70+ | ` stop ` | ` object-stream.stop ` | Skip and terminate the generator (gen/fun only) |
71+ | ` many(values) ` | ` object-stream.many ` | Emit multiple values from a single input |
7272| ` finalValue(value) ` | ` object-stream.final ` | Skip remaining chain steps, emit value directly (gen/fun only) |
73- | ` flushable(fn) ` | ` object-stream.flush ` | Mark function to be called at stream end with ` none ` |
73+ | ` flushable(fn) ` | ` object-stream.flush ` | Mark function to be called at stream end with ` none ` |
7474
7575### gen() — async generator pipeline
7676
7777` gen(...fns) ` takes multiple functions and returns a single async generator function that:
78+
78791 . Processes each input value through the function pipeline sequentially.
79802 . Handles all special return values (` none ` , ` stop ` , ` many ` , ` finalValue ` ).
80813 . Supports regular, async, generator, and async generator functions.
@@ -92,6 +93,7 @@ Functions in a chain can return special values to control flow:
9293### Stream detection
9394
9495` chain() ` detects stream types to decide how to integrate them:
96+
9597- ** Node streams** : ` isReadableNodeStream ` , ` isWritableNodeStream ` , ` isDuplexNodeStream `
9698- ** Web streams** : ` isReadableWebStream ` , ` isWritableWebStream ` , ` isDuplexWebStream `
9799- Web streams are adapted to Node streams via ` Readable.fromWeb() ` , ` Writable.fromWeb() ` , ` Duplex.fromWeb() ` .
@@ -138,6 +140,7 @@ src/utils/* ── src/defs.js (most utilities use none, stop, many, flushable)
138140- ** Run with Deno** : ` npm run test:deno `
139141- ** Run sequential** : ` npm run test:seq ` (also ` test:seq:bun ` , ` test:seq:deno ` )
140142- ** TypeScript check** : ` npm run ts-check `
143+ - ** TypeScript tests** : ` npm run ts-test ` (also ` ts-test:bun ` , ` ts-test:deno ` )
141144- ** Lint** : ` npm run lint ` (Prettier check)
142145- ** Lint fix** : ` npm run lint:fix ` (Prettier write)
143146
0 commit comments