Skip to content

@sheetkit/node / OpenOptions

Interface: OpenOptions ​

Defined in: packages/sheetkit/index.ts:302

Options for controlling how a workbook is opened and parsed.

Properties ​

auxParts? ​

optional auxParts?: AuxParts

Defined in: packages/sheetkit/index.ts:327

Auxiliary parts loading policy. Default: "deferred".


compressionRatioFloorBytes? ​

optional compressionRatioFloorBytes?: number

Defined in: packages/sheetkit/index.ts:311

Decompressed entry size at or below which the compression ratio is not enforced. Default: 8 MiB. 0 enforces the ratio for every entry.


cryptLimits? ​

optional cryptLimits?: CryptLimits | JsCryptLimits

Defined in: packages/sheetkit/index.ts:323

Finite encrypted-container and password-derivation limits.


dateInterpretation? ​

optional dateInterpretation?: DateInterpretation

Defined in: packages/sheetkit/index.ts:334

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.


maxOuterInputBytes? ​

optional maxOuterInputBytes?: number

Defined in: packages/sheetkit/index.ts:304

Maximum bytes accepted from the outer ZIP or encrypted container.


maxUnzipSize? ​

optional maxUnzipSize?: number

Defined in: packages/sheetkit/index.ts:319

Maximum total decompressed size of all ZIP entries in bytes.


maxXmlPartBytes? ​

optional maxXmlPartBytes?: number

Defined in: packages/sheetkit/index.ts:306

Maximum bytes read from one XML part, including lazy hydration.


maxZipEntries? ​

optional maxZipEntries?: number

Defined in: packages/sheetkit/index.ts:321

Maximum number of ZIP entries allowed.


readMode? ​

optional readMode?: ReadMode

Defined in: packages/sheetkit/index.ts:313

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


sheetRows? ​

optional sheetRows?: number

Defined in: packages/sheetkit/index.ts:317

Maximum rows read per sheet. Omit to use the worksheet format maximum.


sheets? ​

optional sheets?: string[]

Defined in: packages/sheetkit/index.ts:315

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


vbaLimits? ​

optional vbaLimits?: VbaLimits | JsVbaLimits

Defined in: packages/sheetkit/index.ts:325

Finite VBA project loading limits.

Released under the MIT / Apache-2.0 License.