Skip to content

@sheetkit/node / OpenOptions

Interface: OpenOptions

Defined in: index.ts:141

Options for controlling how a workbook is opened and parsed.

Properties

auxParts?

optional auxParts: AuxParts

Defined in: index.ts:153

Auxiliary parts loading policy. Default: "deferred".


dateInterpretation?

optional dateInterpretation: DateInterpretation

Defined in: index.ts:160

How to interpret date-formatted number cells while reading. Default: "numFmt" (promote t="n" cells with a date number format into date cells). Set to "cellType" for spec-literal behavior where only t="d" cells become dates.


maxUnzipSize?

optional maxUnzipSize: number

Defined in: index.ts:149

Maximum total decompressed size of all ZIP entries in bytes.


maxZipEntries?

optional maxZipEntries: number

Defined in: index.ts:151

Maximum number of ZIP entries allowed.


readMode?

optional readMode: ReadMode

Defined in: index.ts:143

Read mode: "lazy" (recommended for read-only), "eager", or "stream". Default: "lazy".


sheetRows?

optional sheetRows: number

Defined in: index.ts:147

Maximum number of rows to read per sheet. Omit for unlimited.


sheets?

optional sheets: string[]

Defined in: index.ts:145

Only parse sheets whose names are in this list. Omit to parse all sheets.

Released under the MIT / Apache-2.0 License.