Interface: ReadOptions

Options for reading/parsing workbook files

Hierarchy

Extends:

CommonOptions

Properties

WTF

optional

WTF: boolean

If true, throw errors on unexpected situations instead of silently recovering

bookVBA

optional

bookVBA: boolean

If true, expose VBA macro data in workbook.vbaraw

cellDates

optional

cellDates: boolean

If true, store dates as Date objects instead of serial numbers

sheetStubs

optional

sheetStubs: boolean

If true, include stub cells for empty cells within the used range

cellStyles

optional

cellStyles: boolean

If true, include style/theme information on cells

password

optional

password: string

Workbook password for encrypted files

type

optional

type: "string" | "base64" | "buffer" | "array"

Input data type: "base64" for base64 string, "buffer" for Node Buffer, "array" for Uint8Array, "string" for plain text (CSV/HTML)

cellFormula

optional

cellFormula: boolean

If true, parse and store cell formulas

cellHTML

optional

cellHTML: boolean

If true, generate HTML representation of rich text

cellNF

optional

cellNF: boolean

If true, store the number format string on each cell

cellText

optional

cellText: boolean

If true, generate formatted text for each cell

dateNF

optional

dateNF: string

Override date format string (replaces default "m/d/yy" for format 14)

sheetRows

optional

sheetRows: number

Maximum number of rows to read per sheet (0 = all rows)

bookDeps

optional

bookDeps: boolean

If true, parse inter-sheet dependencies

bookFiles

optional

bookFiles: boolean

If true, expose raw ZIP file entries

bookProps

optional

bookProps: boolean

If true, only parse workbook properties (skip sheet data)

bookSheets

optional

bookSheets: boolean

If true, only parse sheet names (skip sheet data)

sheets

optional

sheets: string | number | (string | number)[]

Restrict parsing to specific sheets by index or name

nodim

optional

nodim: boolean

If true, do not infer sheet dimensions from data

xlfn

optional

xlfn: boolean

If true, preserve _xlfn. prefixes on formula function names

dense

optional

dense: boolean

If true, use dense (2D array) storage mode instead of sparse (object) mode

UTC

optional

UTC: boolean

If true, all dates are interpreted as UTC (no timezone adjustment)

Source

src/types.ts

← Range | RowInfo →