@sheetkit/node / JsOpenOptions
Interface: JsOpenOptions
Defined in: packages/sheetkit/binding.d.ts:850
Options for controlling how a workbook is opened and parsed.
Properties
auxParts?
optionalauxParts?:string
Defined in: packages/sheetkit/binding.d.ts:884
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: "deferred".
compressionRatioFloorBytes?
optionalcompressionRatioFloorBytes?:number
Defined in: packages/sheetkit/binding.d.ts:859
Decompressed entry size at or below which the compression ratio is not enforced. Default: 8 MiB. 0 enforces the ratio for every entry.
cryptLimits?
optionalcryptLimits?:JsCryptLimits
Defined in: packages/sheetkit/binding.d.ts:869
Finite encryption-container and password-derivation limits.
dateInterpretation?
optionaldateInterpretation?:string
Defined in: packages/sheetkit/binding.d.ts:898
Controls how date-formatted number cells are interpreted when the cell carries t="n" (or is untyped). Accepts "numFmt" (default, promote t="n" cells whose style references a built-in date numFmt ID 14-22/45-47, or a custom format code containing date/time tokens, to a date cell) or "cellType" (spec-literal: only t="d" becomes a date). Other values are rejected.
maxOuterInputBytes?
optionalmaxOuterInputBytes?:number
Defined in: packages/sheetkit/binding.d.ts:852
Maximum bytes accepted from an outer ZIP or encrypted container.
maxUnzipSize?
optionalmaxUnzipSize?:number
Defined in: packages/sheetkit/binding.d.ts:865
Maximum total decompressed size of all ZIP entries in bytes.
maxXmlPartBytes?
optionalmaxXmlPartBytes?:number
Defined in: packages/sheetkit/binding.d.ts:854
Maximum bytes read from one XML part, including lazy hydration.
maxZipEntries?
optionalmaxZipEntries?:number
Defined in: packages/sheetkit/binding.d.ts:867
Maximum number of ZIP entries allowed.
parseMode?
optionalparseMode?:string
Defined in: packages/sheetkit/binding.d.ts:889
Backward-compatible alias for read_mode. "readfast" maps to "lazy", "full" maps to "eager". Ignored when read_mode is set.
readMode?
optionalreadMode?:string
Defined in: packages/sheetkit/binding.d.ts:877
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?
optionalsheetRows?:number
Defined in: packages/sheetkit/binding.d.ts:861
Maximum rows read per sheet. Omit to use the worksheet format maximum.
sheets?
optionalsheets?:string[]
Defined in: packages/sheetkit/binding.d.ts:863
Only parse sheets whose names are in this list. Omit to parse all sheets.
vbaLimits?
optionalvbaLimits?:JsVbaLimits
Defined in: packages/sheetkit/binding.d.ts:871
Finite VBA project loading limits.