@sheetkit/node / JsOpenOptions

Interface: JsOpenOptions

Defined in: binding.d.ts:766

Options for controlling how a workbook is opened and parsed.

Properties

auxParts?

optional auxParts: string

Defined in: binding.d.ts:787

Auxiliary parts loading policy: "deferred" or "eager". When "deferred", auxiliary parts (comments, charts, images, etc.) are not parsed during open and are loaded on demand. Default: "eager" (backward compat with existing sync API).

---

maxUnzipSize?

optional maxUnzipSize: number

Defined in: binding.d.ts:772

Maximum total decompressed size of all ZIP entries in bytes.

---

maxZipEntries?

optional maxZipEntries: number

Defined in: binding.d.ts:774

Maximum number of ZIP entries allowed.

---

parseMode?

optional parseMode: string

Defined in: binding.d.ts:792

Backward-compatible alias for read_mode. "readfast" maps to "lazy", "full" maps to "eager". Ignored when read_mode is set.

---

readMode?

optional readMode: string

Defined in: binding.d.ts:780

Read mode: "eager", "lazy" (default for async-first surface), or "stream". Lazy skips auxiliary parts for faster read-only workloads. Stream is reserved for future use and currently behaves like lazy.

---

sheetRows?

optional sheetRows: number

Defined in: binding.d.ts:768

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

---

sheets?

optional sheets: string[]

Defined in: binding.d.ts:770

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