Skip to content

JSON2SheetOpts

Options for creating a worksheet from an array of JSON objects

Interface: JSON2SheetOpts

Options for creating a worksheet from an array of JSON objects

Hierarchy

Extends:

  • CommonOptions

Properties

WTF

optional

WTF: boolean

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

bookVBA

optional

bookVBA: boolean

Reserved compatibility option. A true value is unsupported and throws XlsxError ("UNSUPPORTED").

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

Password for encrypted workbooks; non-empty values are unsupported and throw XlsxError ("UNSUPPORTED")

optional

header: string[]

Explicit header row keys (overrides object key order)

skipHeader

optional

skipHeader: boolean

If true, do not emit a header row

dense

optional

dense: boolean

If true, use dense (2D array) storage mode

dateNF

optional

dateNF: NumberFormat

Date format string for date cells

cellDates

optional

cellDates: boolean

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

UTC

optional

UTC: boolean

If true, interpret dates as UTC

date1904

optional

date1904: boolean

If true, use 1904 date system for date serial numbers

origin

optional

origin: string | number | CellAddress

Starting cell for data: row number, A1 reference, or CellAddress

nullError

optional

nullError: boolean

If true, convert null values to #NULL! error cells

Source

src/types.ts:656


← Hyperlink | MarginInfo →