Skip to content

Sheet2JSONOpts

Options for converting a worksheet to an array of JSON objects

Interface: Sheet2JSONOpts

Options for converting a worksheet to an array of JSON objects

Hierarchy

Extends:

  • WorksheetCellBudgetOptions

Properties

maxWorksheetCells

optional

maxWorksheetCells: number

Maximum cumulative cell work per sheet. This counts explicit cells plus generated column, hyperlink, span, and export positions. XLSX reads default to 10,000,000; exports default to 1,000,000.

optional

header: number | string[] | "A"

"A" for column-letter keys, number for 1-indexed row keys, string[] for custom headers

range

optional

range: any

Restrict output to a specific range (Range object, A1 string, or row number)

blankrows

optional

blankrows: boolean

If true, include blank rows in output

defval

optional

defval: any

Default value for missing cells

raw

optional

raw: boolean

If true, use raw values (v) instead of formatted text (w)

skipHidden

optional

skipHidden: boolean

If true, skip hidden rows and columns

rawNumbers

optional

rawNumbers: boolean

If true, emit raw numeric values for non-date number cells

UTC

optional

UTC: boolean

If true, interpret dates as UTC

dateNF

optional

dateNF: NumberFormat

Override date format for date cells

dateOutput

optional

dateOutput: "iso"

If "iso", emit date/datetime cells as machine-readable ISO-like strings

date1904

optional

date1904: boolean

If true, use 1904 date system for date serial numbers

Source

src/types.ts:589


← Sheet2HTMLOpts | SheetProps →