API reference

Streaming readers & writers

createWriteOnlyWorkbook, loadWorkbookStream, and the iter-based row APIs.

2 exports · 2 source files

Read only

Open an xlsx for read-only streaming access.

function loadWorkbookStream(source: XlsxSource, opts?: LoadWorkbookStreamOptions): Promise<ReadOnlyWorkbook>

Name	Type	Description
`source`	`XlsxSource`
`opts?` = {}	`LoadWorkbookStreamOptions`

Promise<ReadOnlyWorkbook>

Open a workbook for streaming write-only output.

function createWriteOnlyWorkbook(sink: XlsxSink, _opts?: WriteOnlyOptions): Promise<WriteOnlyWorkbook>

Name	Type	Description
`sink`	`XlsxSink`
`_opts?` = {}	`WriteOnlyOptions`

Promise<WriteOnlyWorkbook>