@sheetkit/node / OpenOptions

Interface: OpenOptions

Defined in: index.ts:128

Options for controlling how a workbook is opened and parsed.

Properties

auxParts?

optional auxParts: AuxParts

Defined in: index.ts:140

Auxiliary parts loading policy. Default: "deferred".

---

maxUnzipSize?

optional maxUnzipSize: number

Defined in: index.ts:136

Maximum total decompressed size of all ZIP entries in bytes.

---

maxZipEntries?

optional maxZipEntries: number

Defined in: index.ts:138

Maximum number of ZIP entries allowed.

---

readMode?

optional readMode: ReadMode

Defined in: index.ts:130

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

---

sheetRows?

optional sheetRows: number

Defined in: index.ts:134

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

---

sheets?

optional sheets: string[]

Defined in: index.ts:132

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