Skip to content

@sheetkit/node / SheetStreamReader

Class: SheetStreamReader ​

Defined in: index.ts:263

Forward-only streaming reader for worksheet data. Reads rows in batches.

Methods ​

[asyncIterator]() ​

[asyncIterator](): AsyncGenerator<JsRowData[], void, undefined>

Defined in: index.ts:288

Async iterator that yields batches of rows.

Returns ​

AsyncGenerator<JsRowData[], void, undefined>


close() ​

close(): Promise<void>

Defined in: index.ts:283

Close the reader and release resources.

Returns ​

Promise<void>


next() ​

next(batchSize?): Promise<JsRowData[] | null>

Defined in: index.ts:277

Read the next batch of rows. Returns an array of row data objects, or null when there are no more rows.

Parameters ​

batchSize? ​

number

Returns ​

Promise<JsRowData[] | null>

Released under the MIT / Apache-2.0 License.