streams
Source: lib/streams.js (pure JS)
Higher-level helpers built on top of the WHATWG stream
implementation — file-backed streams, line iteration, and text transform
streams. Re-exports everything from lib/stream.js (the full WHATWG streams, with pipeTo()/pipeThrough()).
Exports
| Export | Args | Kind | Description |
|---|---|---|---|
| (re-export) | — | — | export * from './stream.js' — all stream classes. |
FileSystemReadableStream(file, bufSize) | 1–2 | function | A ReadableStream reading from an open file. |
FileSystemReadableFileStream(path, bufSize) | 1–2 | function | A ReadableStream reading from a path. |
FileSystemWritableFileStream(path) | 1 | function | A WritableStream writing to a path. |
StreamReadIterator(strm) | 1 | async generator | Yields chunks read from a stream. |
LineStreamIterator(strm) | 1 | async generator | Yields lines read from a stream. |
ByLineStream | — | const | A transform that splits a byte stream into lines. |
TextEncoderStream | — | class | Transforms strings → bytes (extends TransformStream). |
TextDecoderStream | — | class | Transforms bytes → strings (extends TransformStream). |
Export list
Generated by utilities/doc-api.js from the streams dump of utilities/api-surface.sh: 118 members. Edit the text above this block, not the block.
Functions: ByLineStream(), FileSystemReadableFileStream(), FileSystemReadableStream(), FileSystemWritableFileStream(), LineStreamIterator(), StreamReadIterator(), TextEncoderStream()
ByteLengthQueuingStrategy
class, constructible
- properties:
highWaterMark (get),size (get),[Symbol.toStringTag]
CountQueuingStrategy
class, constructible
- properties:
highWaterMark (get),size (get),[Symbol.toStringTag]
ReadableByteStreamController
class, constructible
- methods:
close(),enqueue(),error(),[Symbol([[CancelSteps]])](),[Symbol([[PullSteps]])](),[Symbol([[ReleaseSteps]])]() - properties:
byobRequest (get),desiredSize (get),[Symbol.toStringTag]
ReadableStream
class, constructible
- static methods:
from() - methods:
cancel(),getReader(),pipeThrough(),pipeTo(),tee(),values(),[Symbol.asyncIterator]() - properties:
locked (get),[Symbol.toStringTag]
ReadableStreamAsyncIteratorImpl
class, constructible
- methods:
_nextSteps(),_returnSteps(),next(),return()
ReadableStreamBYOBReader
class, constructible
- methods:
cancel(),read(),releaseLock() - properties:
closed (get),[Symbol.toStringTag]
ReadableStreamBYOBRequest
class, constructible
- methods:
respond(),respondWithNewView() - properties:
view (get),[Symbol.toStringTag]
ReadableStreamDefaultController
class, constructible
- methods:
close(),enqueue(),error(),[Symbol([[CancelSteps]])](),[Symbol([[PullSteps]])](),[Symbol([[ReleaseSteps]])]() - properties:
desiredSize (get),[Symbol.toStringTag]
ReadableStreamDefaultReader
class, constructible
- methods:
cancel(),read(),releaseLock() - properties:
closed (get),[Symbol.toStringTag]
TextDecoderStream
class, constructible
- properties:
encoding (get),fatal (get),ignoreBOM (get)
TransformStream
class, constructible
- properties:
readable (get),writable (get),[Symbol.toStringTag]
TransformStreamDefaultController
class, constructible
- methods:
enqueue(),error(),terminate() - properties:
desiredSize (get),[Symbol.toStringTag]
WritableStream
class, constructible
- methods:
abort(),close(),getWriter() - properties:
locked (get),[Symbol.toStringTag]
WritableStreamDefaultController
class, constructible
- methods:
error(),[Symbol([[AbortSteps]])](),[Symbol([[ErrorSteps]])]() - properties:
abortReason (get),signal (get),[Symbol.toStringTag]
WritableStreamDefaultWriter
class, constructible
- methods:
abort(),close(),releaseLock(),write() - properties:
closed (get),desiredSize (get),ready (get),[Symbol.toStringTag]