Files

admin 9bf56a806b Move docs/ package mirror into document-navigator plugin

Relocate the ~6k-file docs tree from the repo root into
plugins/document-navigator/docs/ so the plugin is self-contained and
portable. docs/superpowers/ (specs and plans) stays at the repo root.

Moved via cp+rm rather than git mv because directory rename() fails with
EPERM on this WSL /mnt DrvFs mount; git rename-detection pairs the
identical-content files at commit time.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

2026-05-30 01:10:00 +01:00

55 KiB

Raw Blame History

@suaveplan/streams - WHATWG-Streams-based primitives: backpressure-first transforms, zero-copy Uint8Array operations, AbortSignal integration, OTel instrumentation

Summary

WHATWG-Streams-based primitives: backpressure-first transforms, zero-copy Uint8Array operations, AbortSignal integration end-to-end, structured errors, OTel instrumentation, and property-based invariant tests.

Documentation tree

transform — (no submodules)
- transform — (no submodules)
errors — (no submodules)
- stream-error — (no submodules)
factory — (no submodules)
- factory — (no submodules)
transform — (no submodules)
- transform — (no submodules)
manager — (no submodules)
- manager — (no submodules)
node — (no submodules)
- node-adapters — (no submodules)
builder — (no submodules)
- builder — (no submodules)
concat — (no submodules)
- concat — (no submodules)
fan-out — (no submodules)
- fan-out — (no submodules)
merge — (no submodules)
- merge — (no submodules)
merge-ordered — (no submodules)
- merge-ordered — (no submodules)
partition — (no submodules)
- partition — (no submodules)
route — (no submodules)
- route — (no submodules)
safe-branch — (no submodules)
- safe-branch — (no submodules)
zip — (no submodules)
- zip — (no submodules)
duplex — (no submodules)
- duplex — (no submodules)
network — (no submodules)
- network — (no submodules)
from-array — (no submodules)
- from-array — (no submodules)
from-bytes — (no submodules)
- from-bytes — (no submodules)
from-generator — (no submodules)
- from-generator — (no submodules)
for-each — (no submodules)
- for-each — (no submodules)
to-array — (no submodules)
- to-array — (no submodules)
to-async-iterable — (no submodules)
- to-async-iterable — (no submodules)
to-bytes — (no submodules)
- to-bytes — (no submodules)
batch — (no submodules)
- batch — (no submodules)
chunk-bytes — (no submodules)
- chunk-bytes — (no submodules)
coalesce-bytes — (no submodules)
- coalesce-bytes — (no submodules)
compress — (no submodules)
- compress — (no submodules)
crypto — (no submodules)
- crypto — (no submodules)
dedup — (no submodules)
- dedup — (no submodules)
filter — (no submodules)
- filter — (no submodules)
flat-map — (no submodules)
- flat-map — (no submodules)
length-prefix-decode — (no submodules)
- length-prefix-decode — (no submodules)
length-prefix-encode — (no submodules)
- length-prefix-encode — (no submodules)
limit — (no submodules)
- limit — (no submodules)
map — (no submodules)
- map — (no submodules)
sliding-bytes — (no submodules)
- sliding-bytes — (no submodules)
split-join — (no submodules)
- split-join — (no submodules)
tap — (no submodules)
- tap — (no submodules)
text-codec — (no submodules)
- text-codec — (no submodules)
throttle — (no submodules)
- throttle — (no submodules)
window — (no submodules)
- window — (no submodules)
types — (no submodules)
- common — (no submodules)
buffer-to-uint8 — (no submodules)
- buffer-to-uint8 — (no submodules)
get-data-from-file — (no submodules)
- get-data-from-file — (no submodules)
uint8-slice — (no submodules)
- uint8-slice — (no submodules)
create-data-stream — (no submodules)
- create-data-stream — (no submodules)
process-data-stream — (no submodules)
- process-data-stream — (no submodules)
round-trip — (no submodules)
- round-trip — (no submodules)
validate-integrity — (no submodules)
- validate-integrity — (no submodules)

- [transform](./src/base/transform/transform.md) — _(no submodules)_- [errors](./src/errors/stream-error.md) — _(no submodules)_- [stream-error](./src/errors/stream-error.md) — _(no submodules)_- [factory](./src/factory/factory/factory.md) — _(no submodules)_- [factory](./src/factory/factory/factory.md) — _(no submodules)_- [transform](./src/instrument/transform/transform.md) — _(no submodules)_- [transform](./src/instrument/transform/transform.md) — _(no submodules)_- [manager](./src/manager/manager/manager.md) — _(no submodules)_- [manager](./src/manager/manager/manager.md) — _(no submodules)_- [node](./src/node/node-adapters.md) — _(no submodules)_- [node-adapters](./src/node/node-adapters.md) — _(no submodules)_- [builder](./src/pipeline/builder/builder.md) — _(no submodules)_- [builder](./src/pipeline/builder/builder.md) — _(no submodules)_- [concat](./src/pipeline/concat/concat.md) — _(no submodules)_- [concat](./src/pipeline/concat/concat.md) — _(no submodules)_- [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_- [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_- [merge](./src/pipeline/merge/merge.md) — _(no submodules)_- [merge](./src/pipeline/merge/merge.md) — _(no submodules)_- [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_- [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_- [partition](./src/pipeline/partition/partition.md) — _(no submodules)_- [partition](./src/pipeline/partition/partition.md) — _(no submodules)_- [route](./src/pipeline/route/route.md) — _(no submodules)_- [route](./src/pipeline/route/route.md) — _(no submodules)_- [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_- [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_- [zip](./src/pipeline/zip/zip.md) — _(no submodules)_- [zip](./src/pipeline/zip/zip.md) — _(no submodules)_- [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_- [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_- [network](./src/primitives/network/network.md) — _(no submodules)_- [network](./src/primitives/network/network.md) — _(no submodules)_- [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_- [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_- [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_- [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_- [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_- [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_- [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_- [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_- [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_- [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_- [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_- [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_- [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_- [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_- [batch](./src/transforms/batch/batch.md) — _(no submodules)_- [batch](./src/transforms/batch/batch.md) — _(no submodules)_- [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_- [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_- [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_- [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_- [compress](./src/transforms/compress/compress.md) — _(no submodules)_- [compress](./src/transforms/compress/compress.md) — _(no submodules)_- [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_- [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_- [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_- [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_- [filter](./src/transforms/filter/filter.md) — _(no submodules)_- [filter](./src/transforms/filter/filter.md) — _(no submodules)_- [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_- [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_- [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_- [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_- [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_- [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_- [limit](./src/transforms/limit/limit.md) — _(no submodules)_- [limit](./src/transforms/limit/limit.md) — _(no submodules)_- [map](./src/transforms/map/map.md) — _(no submodules)_- [map](./src/transforms/map/map.md) — _(no submodules)_- [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_- [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_- [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_- [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_- [tap](./src/transforms/tap/tap.md) — _(no submodules)_- [tap](./src/transforms/tap/tap.md) — _(no submodules)_- [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_- [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_- [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_- [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_- [window](./src/transforms/window/window.md) — _(no submodules)_- [window](./src/transforms/window/window.md) — _(no submodules)_- [types](./src/types/common.md) — _(no submodules)_- [common](./src/types/common.md) — _(no submodules)_- [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_- [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_- [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_- [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_- [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_- [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_- [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_- [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_- [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_- [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_- [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_- [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_- [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_- [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_- [transform](./src/base/transform/transform.md) — _(no submodules)_- [errors](./src/errors/stream-error.md) — _(no submodules)_- [stream-error](./src/errors/stream-error.md) — _(no submodules)_- [factory](./src/factory/factory/factory.md) — _(no submodules)_- [factory](./src/factory/factory/factory.md) — _(no submodules)_- [transform](./src/instrument/transform/transform.md) — _(no submodules)_- [transform](./src/instrument/transform/transform.md) — _(no submodules)_- [manager](./src/manager/manager/manager.md) — _(no submodules)_- [manager](./src/manager/manager/manager.md) — _(no submodules)_- [node](./src/node/node-adapters.md) — _(no submodules)_- [node-adapters](./src/node/node-adapters.md) — _(no submodules)_- [builder](./src/pipeline/builder/builder.md) — _(no submodules)_- [builder](./src/pipeline/builder/builder.md) — _(no submodules)_- [concat](./src/pipeline/concat/concat.md) — _(no submodules)_- [concat](./src/pipeline/concat/concat.md) — _(no submodules)_- [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_- [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_- [merge](./src/pipeline/merge/merge.md) — _(no submodules)_- [merge](./src/pipeline/merge/merge.md) — _(no submodules)_- [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_- [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_- [partition](./src/pipeline/partition/partition.md) — _(no submodules)_- [partition](./src/pipeline/partition/partition.md) — _(no submodules)_- [route](./src/pipeline/route/route.md) — _(no submodules)_- [route](./src/pipeline/route/route.md) — _(no submodules)_- [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_- [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_- [zip](./src/pipeline/zip/zip.md) — _(no submodules)_- [zip](./src/pipeline/zip/zip.md) — _(no submodules)_- [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_- [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_- [network](./src/primitives/network/network.md) — _(no submodules)_- [network](./src/primitives/network/network.md) — _(no submodules)_- [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_- [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_- [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_- [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_- [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_- [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_- [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_- [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_- [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_- [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_- [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_- [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_- [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_- [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_- [batch](./src/transforms/batch/batch.md) — _(no submodules)_- [batch](./src/transforms/batch/batch.md) — _(no submodules)_- [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_- [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_- [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_- [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_- [compress](./src/transforms/compress/compress.md) — _(no submodules)_- [compress](./src/transforms/compress/compress.md) — _(no submodules)_- [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_- [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_- [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_- [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_- [filter](./src/transforms/filter/filter.md) — _(no submodules)_- [filter](./src/transforms/filter/filter.md) — _(no submodules)_- [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_- [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_- [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_- [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_- [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_- [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_- [limit](./src/transforms/limit/limit.md) — _(no submodules)_- [limit](./src/transforms/limit/limit.md) — _(no submodules)_- [map](./src/transforms/map/map.md) — _(no submodules)_- [map](./src/transforms/map/map.md) — _(no submodules)_- [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_- [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_- [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_- [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_- [tap](./src/transforms/tap/tap.md) — _(no submodules)_- [tap](./src/transforms/tap/tap.md) — _(no submodules)_- [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_- [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_- [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_- [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_- [window](./src/transforms/window/window.md) — _(no submodules)_- [window](./src/transforms/window/window.md) — _(no submodules)_- [types](./src/types/common.md) — _(no submodules)_- [common](./src/types/common.md) — _(no submodules)_- [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_- [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_- [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_- [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_- [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_- [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_- [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_- [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_- [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_- [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_- [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_- [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_- [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_- [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_- [transform](./src/base/transform/transform.md) — _(no submodules)_- [errors](./src/errors/stream-error.md) — _(no submodules)_- [stream-error](./src/errors/stream-error.md) — _(no submodules)_- [factory](./src/factory/factory/factory.md) — _(no submodules)_- [factory](./src/factory/factory/factory.md) — _(no submodules)_- [transform](./src/instrument/transform/transform.md) — _(no submodules)_- [transform](./src/instrument/transform/transform.md) — _(no submodules)_- [manager](./src/manager/manager/manager.md) — _(no submodules)_- [manager](./src/manager/manager/manager.md) — _(no submodules)_- [node](./src/node/node-adapters.md) — _(no submodules)_- [node-adapters](./src/node/node-adapters.md) — _(no submodules)_- [builder](./src/pipeline/builder/builder.md) — _(no submodules)_- [builder](./src/pipeline/builder/builder.md) — _(no submodules)_- [concat](./src/pipeline/concat/concat.md) — _(no submodules)_- [concat](./src/pipeline/concat/concat.md) — _(no submodules)_- [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_- [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_- [merge](./src/pipeline/merge/merge.md) — _(no submodules)_- [merge](./src/pipeline/merge/merge.md) — _(no submodules)_- [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_- [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_- [partition](./src/pipeline/partition/partition.md) — _(no submodules)_- [partition](./src/pipeline/partition/partition.md) — _(no submodules)_- [route](./src/pipeline/route/route.md) — _(no submodules)_- [route](./src/pipeline/route/route.md) — _(no submodules)_- [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_- [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_- [zip](./src/pipeline/zip/zip.md) — _(no submodules)_- [zip](./src/pipeline/zip/zip.md) — _(no submodules)_- [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_- [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_- [network](./src/primitives/network/network.md) — _(no submodules)_- [network](./src/primitives/network/network.md) — _(no submodules)_- [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_- [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_- [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_- [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_- [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_- [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_- [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_- [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_- [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_- [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_- [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_- [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_- [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_- [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_- [batch](./src/transforms/batch/batch.md) — _(no submodules)_- [batch](./src/transforms/batch/batch.md) — _(no submodules)_- [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_- [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_- [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_- [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_- [compress](./src/transforms/compress/compress.md) — _(no submodules)_- [compress](./src/transforms/compress/compress.md) — _(no submodules)_- [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_- [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_- [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_- [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_- [filter](./src/transforms/filter/filter.md) — _(no submodules)_- [filter](./src/transforms/filter/filter.md) — _(no submodules)_- [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_- [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_- [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_- [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_- [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_- [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_- [limit](./src/transforms/limit/limit.md) — _(no submodules)_- [limit](./src/transforms/limit/limit.md) — _(no submodules)_- [map](./src/transforms/map/map.md) — _(no submodules)_- [map](./src/transforms/map/map.md) — _(no submodules)_- [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_- [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_- [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_- [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_- [tap](./src/transforms/tap/tap.md) — _(no submodules)_- [tap](./src/transforms/tap/tap.md) — _(no submodules)_- [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_- [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_- [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_- [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_- [window](./src/transforms/window/window.md) — _(no submodules)_- [window](./src/transforms/window/window.md) — _(no submodules)_- [types](./src/types/common.md) — _(no submodules)_- [common](./src/types/common.md) — _(no submodules)_- [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_- [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_- [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_- [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_- [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_- [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_- [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_- [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_- [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_- [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_- [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_- [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_- [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_- [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_- [transform](./src/base/transform/transform.md) — _(no submodules)_- [errors](./src/errors/stream-error.md) — _(no submodules)_ - [stream-error](./src/errors/stream-error.md) — _(no submodules)_- [factory](./src/factory/factory/factory.md) — _(no submodules)_ - [factory](./src/factory/factory/factory.md) — _(no submodules)_- [transform](./src/instrument/transform/transform.md) — _(no submodules)_ - [transform](./src/instrument/transform/transform.md) — _(no submodules)_- [manager](./src/manager/manager/manager.md) — _(no submodules)_ - [manager](./src/manager/manager/manager.md) — _(no submodules)_- [node](./src/node/node-adapters.md) — _(no submodules)_ - [node-adapters](./src/node/node-adapters.md) — _(no submodules)_- [builder](./src/pipeline/builder/builder.md) — _(no submodules)_ - [builder](./src/pipeline/builder/builder.md) — _(no submodules)_- [concat](./src/pipeline/concat/concat.md) — _(no submodules)_ - [concat](./src/pipeline/concat/concat.md) — _(no submodules)_- [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_ - [fan-out](./src/pipeline/fan-out/fan-out.md) — _(no submodules)_- [merge](./src/pipeline/merge/merge.md) — _(no submodules)_ - [merge](./src/pipeline/merge/merge.md) — _(no submodules)_- [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_ - [merge-ordered](./src/pipeline/merge-ordered/merge-ordered.md) — _(no submodules)_- [partition](./src/pipeline/partition/partition.md) — _(no submodules)_ - [partition](./src/pipeline/partition/partition.md) — _(no submodules)_- [route](./src/pipeline/route/route.md) — _(no submodules)_ - [route](./src/pipeline/route/route.md) — _(no submodules)_- [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_ - [safe-branch](./src/pipeline/safe-branch/safe-branch.md) — _(no submodules)_- [zip](./src/pipeline/zip/zip.md) — _(no submodules)_ - [zip](./src/pipeline/zip/zip.md) — _(no submodules)_- [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_ - [duplex](./src/primitives/duplex/duplex.md) — _(no submodules)_- [network](./src/primitives/network/network.md) — _(no submodules)_ - [network](./src/primitives/network/network.md) — _(no submodules)_- [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_ - [from-array](./src/readable/from-array/from-array.md) — _(no submodules)_- [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_ - [from-bytes](./src/readable/from-bytes/from-bytes.md) — _(no submodules)_- [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_ - [from-generator](./src/readable/from-generator/from-generator.md) — _(no submodules)_- [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_ - [for-each](./src/sinks/for-each/for-each.md) — _(no submodules)_- [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_ - [to-array](./src/sinks/to-array/to-array.md) — _(no submodules)_- [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_ - [to-async-iterable](./src/sinks/to-async-iterable/to-async-iterable.md) — _(no submodules)_- [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_ - [to-bytes](./src/sinks/to-bytes/to-bytes.md) — _(no submodules)_- [batch](./src/transforms/batch/batch.md) — _(no submodules)_ - [batch](./src/transforms/batch/batch.md) — _(no submodules)_- [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_ - [chunk-bytes](./src/transforms/chunk-bytes/chunk-bytes.md) — _(no submodules)_- [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_ - [coalesce-bytes](./src/transforms/coalesce-bytes/coalesce-bytes.md) — _(no submodules)_- [compress](./src/transforms/compress/compress.md) — _(no submodules)_ - [compress](./src/transforms/compress/compress.md) — _(no submodules)_- [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_ - [crypto](./src/transforms/crypto/crypto.md) — _(no submodules)_- [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_ - [dedup](./src/transforms/dedup/dedup.md) — _(no submodules)_- [filter](./src/transforms/filter/filter.md) — _(no submodules)_ - [filter](./src/transforms/filter/filter.md) — _(no submodules)_- [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_ - [flat-map](./src/transforms/flat-map/flat-map.md) — _(no submodules)_- [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_ - [length-prefix-decode](./src/transforms/length-prefix-decode/length-prefix-decode.md) — _(no submodules)_- [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_ - [length-prefix-encode](./src/transforms/length-prefix-encode/length-prefix-encode.md) — _(no submodules)_- [limit](./src/transforms/limit/limit.md) — _(no submodules)_ - [limit](./src/transforms/limit/limit.md) — _(no submodules)_- [map](./src/transforms/map/map.md) — _(no submodules)_ - [map](./src/transforms/map/map.md) — _(no submodules)_- [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_ - [sliding-bytes](./src/transforms/sliding-bytes/sliding-bytes.md) — _(no submodules)_- [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_ - [split-join](./src/transforms/split-join/split-join.md) — _(no submodules)_- [tap](./src/transforms/tap/tap.md) — _(no submodules)_ - [tap](./src/transforms/tap/tap.md) — _(no submodules)_- [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_ - [text-codec](./src/transforms/text-codec/text-codec.md) — _(no submodules)_- [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_ - [throttle](./src/transforms/throttle/throttle.md) — _(no submodules)_- [window](./src/transforms/window/window.md) — _(no submodules)_ - [window](./src/transforms/window/window.md) — _(no submodules)_- [types](./src/types/common.md) — _(no submodules)_ - [common](./src/types/common.md) — _(no submodules)_- [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_ - [buffer-to-uint8](./src/utils/buffer/buffer-to-uint8/buffer-to-uint8.md) — _(no submodules)_- [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_ - [get-data-from-file](./src/utils/buffer/get-data-from-file/get-data-from-file.md) — _(no submodules)_- [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_ - [uint8-slice](./src/utils/buffer/uint8-slice/uint8-slice.md) — _(no submodules)_- [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_ - [create-data-stream](./src/utils/stream/create-data-stream/create-data-stream.md) — _(no submodules)_- [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_ - [process-data-stream](./src/utils/stream/process-data-stream/process-data-stream.md) — _(no submodules)_- [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_ - [round-trip](./src/utils/stream/round-trip/round-trip.md) — _(no submodules)_- [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_ - [validate-integrity](./src/utils/stream/validate-integrity/validate-integrity.md) — _(no submodules)_

Installation

bun add @suaveplan/streams

Modules

Module	Description
errors/stream-error	`StreamError` hierarchy and `STREAM.*` error codes
readable/from-array	`fromArray<T>`
readable/from-generator	`fromAsyncGenerator<T>`
readable/from-bytes	`fromBytes`, `concatByteStreams`, `sliceByteStream`
transforms/map-stream	`mapStream<TIn,TOut>`
transforms/filter-stream	`filterStream<T>`
transforms/flat-map-stream	`flatMapStream<TIn,TOut>`
transforms/tap-stream	`tapStream<T>`
transforms/batch-stream	`batchStream<T>`
transforms/window-stream	`windowStream<T>`
transforms/throttle-stream	`throttleStream<T>`
transforms/dedup-stream	`dedupStream<T>`
transforms/limit-stream	`limitStream<T>`
transforms/text-codec	`encodeTextStream`, `decodeTextStream`
transforms/compress	`compressStream`, `decompressStream`
sinks/to-array	`toArray`, `collect`
sinks/to-bytes	`toBytes`, `toString`
sinks/for-each	`forEach`, `toWritable`, `drain`
pipeline/pipeline-builder	`pipeline()`, `PipelineBuilder`
pipeline/fan-out	`fanOut`
pipeline/merge	`merge`
instrument/instrument-transform	`instrumentTransform`
node/node-adapters	`fromNodeReadable`, `toNodeReadable`, `fromNodeWritable`

Quick Start

import { fromArray, mapStream, filterStream, batchStream, toArray, pipeline } from "@suaveplan/streams";

// Fluent pipeline builder
const result = await pipeline(fromArray([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]))
  .pipe(filterStream((n) => n % 2 === 0))
  .pipe(mapStream((n) => n * n))
  .pipe(batchStream(3))
  .collect();

console.log(result); // [[4, 16, 36], [64, 100]]

55 KiB Raw Blame History