API / interfaces / workbook

Interface: WorkBook

Top-level Workbook object containing all sheets, properties, and metadata

Properties

Sheets

Sheets: { [sheet: string]: WorkSheet }

Map of sheet names to WorkSheet objects

SheetNames

SheetNames: string[]

Ordered list of sheet names (determines tab order)

Props

optional

Props: FullProperties

File and document properties

Custprops

optional

Custprops: Record<string, any>

Custom document properties (arbitrary key-value pairs)

Workbook

optional

Workbook: WBProps

Workbook-level attributes (names, views, sheet props)

vbaraw

optional

vbaraw: any

Raw VBA project binary (when bookVBA option is enabled)

bookType

optional

bookType: string

File format type identifier

Source

src/types.ts

← WBView | WorkbookProperties →