Class IterableReadableStream<T>

A ReadableStream that supports async iteration. Extends the standard ReadableStream with Symbol.asyncIterator support.

Example

const stream = new IterableReadableStream<Uint8Array>(...)
for await (const chunk of stream) {
  console.log(chunk)
}

Type Parameters

T
The type of chunks yielded by the stream.

Hierarchy (View Summary)

ReadableStream<T>
- IterableReadableStream
  - PdfObjectStream

Index

Constructors

constructor

Methods

[asyncIterator]

Constructors

constructor

new IterableReadableStream<T>(
underlyingSource: UnderlyingDefaultSource<T>,
strategy?: QueuingStrategy<T>,
): IterableReadableStream<T>
Type Parameters
- T
Parameters
- underlyingSource: UnderlyingDefaultSource<T>
- Optionalstrategy: QueuingStrategy<T>
Returns IterableReadableStream<T>
Inherited from ReadableStream<T>.constructor
- Defined in node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/lib/lib.dom.d.ts:30286
new IterableReadableStream<T>(
underlyingSource?: UnderlyingSource<T>,
strategy?: QueuingStrategy<T>,
): IterableReadableStream<T>
Type Parameters
- T
Parameters
- OptionalunderlyingSource: UnderlyingSource<T>
- Optionalstrategy: QueuingStrategy<T>
Returns IterableReadableStream<T>
Inherited from ReadableStream<T>.constructor
- Defined in node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/lib/lib.dom.d.ts:30287

Methods

[asyncIterator]

"[asyncIterator]"(): {
    "[asyncDispose]"(): Promise<void>;
    "[asyncIterator]"(): { next(): Promise<IteratorResult<T, any>>; [Symbol.asyncIterator](): ...; [Symbol.asyncDispose](): Promise<void>; };
    next(): Promise<IteratorResult<T, any>>;
}
Returns an async iterator for the stream.

Returns {
    "[asyncDispose]"(): Promise<void>;
    "[asyncIterator]"(): { next(): Promise<IteratorResult<T, any>>; [Symbol.asyncIterator](): ...; [Symbol.asyncDispose](): Promise<void>; };
    next(): Promise<IteratorResult<T, any>>;
}
An async iterator that yields chunks from the stream.
Overrides ReadableStream.[asyncIterator]
- Defined in packages/pdf-lite/src/utils/iterable-readable-stream.ts:21

Class IterableReadableStream<T>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns IterableReadableStream<T>

Type Parameters

Parameters

Returns IterableReadableStream<T>

Methods

[asyncIterator]

Returns {
    "[asyncDispose]"(): Promise<void>;
    "[asyncIterator]"(): { next(): Promise<IteratorResult<T, any>>; [Symbol.asyncIterator](): ...; [Symbol.asyncDispose](): Promise<void>; };
    next(): Promise<IteratorResult<T, any>>;
}

Settings

On This Page

Class IterableReadableStream<T>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns IterableReadableStream<T>

Type Parameters

Parameters

Returns IterableReadableStream<T>

Methods

[asyncIterator]

Returns { "[asyncDispose]"(): Promise<void>; "[asyncIterator]"(): { next(): Promise<IteratorResult<T, any>>; [Symbol.asyncIterator](): ...; [Symbol.asyncDispose](): Promise<void>; }; next(): Promise<IteratorResult<T, any>>;}

Settings

On This Page

Returns {
"[asyncDispose]"(): Promise<void>;
"[asyncIterator]"(): { next(): Promise<IteratorResult<T, any>>; [Symbol.asyncIterator](): ...; [Symbol.asyncDispose](): Promise<void>; };
next(): Promise<IteratorResult<T, any>>;
}