Class ReadStream`Abstract`

Abstract base class for streaming data from a source. Uses a pull-based model where the consumer provides the buffer.

Hierarchy (View Summary)

ReadStream
- BufferedReadStream

Index

Constructors

Properties

bytesRead expectedSize

Methods

close pull readAll

Constructors

constructor

new ReadStream(expectedSize?: number): ReadStream
Parameters
- OptionalexpectedSize: number
  Optional size hint for buffer pre-allocation
Returns ReadStream
- Defined in io/read/file-system.ts:20

Properties

bytesRead

bytesRead: number = 0

Total bytes read from this stream so far.

`Readonly`expectedSize

expectedSize: number

Size hint for buffer pre-allocation in readAll(). May be undefined if size is unknown.

Methods

close

close(): void
Release resources and abort any pending operations.

Returns void
- Defined in io/read/file-system.ts:61

`Abstract`pull

pull(target: Uint8Array): Promise<number>
Pull data into the provided buffer.
Parameters
- target: Uint8Array
  Buffer to fill with data
Returns Promise<number>
Number of bytes read, or 0 for EOF
- Defined in io/read/file-system.ts:29

readAll

readAll(): Promise<Uint8Array<ArrayBufferLike>>
Read entire stream into a single buffer. Uses expectedSize hint if available, grows dynamically if needed.

Returns Promise<Uint8Array<ArrayBufferLike>>
Complete data as Uint8Array
- Defined in io/read/file-system.ts:36