Elide експортує Readable, Writable, Duplex, Transform і PassThrough.
Наведений нижче перевірений приклад охоплює Readable.from, власні хуки
Transform і Writable та завершення конвеєра на основі Promise.
Приклад конвеєра
Використовуйте node:stream/promises, коли очікуєте pipeline через await:
import { Readable, Transform, Writable } from "node:stream";
import { pipeline } from "node:stream/promises";
const output = [];
const source = Readable.from(["a", "b"]);
const upper = new Transform({
transform(chunk, _encoding, callback) {
callback(null, String(chunk).toUpperCase());
},
});
const sink = new Writable({
write(chunk, _encoding, callback) {
output.push(String(chunk));
callback();
},
});
await pipeline(source, upper, sink);
console.log(output.join("")); // ABpipeline і finished з node:stream використовують сигнатури з функціями
зворотного виклику. Їхні форми, що повертають Promise, експортує
node:stream/promises.
Додатковий інтерфейс
Readable.from,Readable.wrapі асинхронна ітерація- споживачі на Promise, як-от
toArray,forEach,some,every,findіreduce - перетворювачі потоків, як-от
map,filter,flatMap,dropіtake compose,addAbortSignal, предикати стану та допоміжні засоби high-water marknode:stream/iter— розширення Elide з допоміжними засобами перетворення ітераторів
Стандартні сигнатури класів і хуків описано в документації Node.js щодо stream.
Reference
Status: Partial · 215 of 238 suite tests pass (90.3%) · since 1.1.0
Exports
| Export | Kind | Status | Notes |
|---|---|---|---|
Readable | class | Full | readable, readableEnded, readableFlowing, readableHighWaterMark, readableLength, readableObjectMode, readableEncoding, destroyed, read(), setEncoding(), pause(), resume(), isPaused(), unpipe(), unshift(), wrap(), push(), destroy(), pipe(), toArray(), forEach(), some(), every(), find(), reduce(), map(), filter(), flatMap(), drop(), take() |
Writable | class | Full | writable, writableEnded, writableFinished, writableHighWaterMark, writableLength, writableObjectMode, writableCorked, destroyed, write(), end(), cork(), uncork(), destroy(), setDefaultEncoding() |
Duplex | class | Full | writable, writableEnded, writableFinished, writableHighWaterMark, writableLength, writableObjectMode, writableCorked, write(), end(), cork(), uncork(), setDefaultEncoding() |
Transform | class | Full | |
PassThrough | class | Full | |
Readable | property | Full | The Readable stream class |
Writable | property | Full | The Writable stream class |
Duplex | property | Full | The Duplex stream class |
Transform | property | Full | The Transform stream class |
PassThrough | property | Full | The PassThrough stream class |
pipeline | property | Full | Promise-based pipeline() utility for composing stream pipelines with error propagation |
finished | property | Full | Promise-based finished() utility that resolves/rejects when a stream completes or errors |
compose | property | Full | Composes streams into a single Duplex; pipes them and returns a Duplex that writes to the head and reads… |
Not implemented
stream/web.ReadableStreamTee.
Tests: node-api node:streams: 215 pass, 22 fail, 1 error, 9 skipped. Failing: test-stream-auto-destroy.js, test-stream-compose.js, test-stream-consumers.js, test-stream-destroy.js, test-stream-duplex-from.js, test-stream-duplex.js, test-stream-iter-disabled.js, test-stream-iter-readable-interop-disabled.js, and 15 more.