# xlsx-format

> The XLSX library your bundler will thank you for. Zero dependencies. Promise-based read/write APIs. TypeScript-first.

## Docs

- [API Reference](/xlsx-format/api-reference): Auto-generated API documentation
- [Classes](/xlsx-format/api-reference/classes)
- [XlsxError](/xlsx-format/api-reference/classes/xlsxerror): Error subclass thrown by xlsx-format for deterministic failure handling.
- [Functions](/xlsx-format/api-reference/functions)
- [api/aoa Functions](/xlsx-format/api-reference/functions/api-aoa): Functions from src/api/aoa.ts
- [api/book Functions](/xlsx-format/api-reference/functions/api-book): Functions from src/api/book.ts
- [api/csv Functions](/xlsx-format/api-reference/functions/api-csv): Functions from src/api/csv.ts
- [api/format Functions](/xlsx-format/api-reference/functions/api-format): Functions from src/api/format.ts
- [api/html Functions](/xlsx-format/api-reference/functions/api-html): Functions from src/api/html.ts
- [api/json Functions](/xlsx-format/api-reference/functions/api-json): Functions from src/api/json.ts
- [read Functions](/xlsx-format/api-reference/functions/read): Functions from src/read.ts
- [ssf/format Functions](/xlsx-format/api-reference/functions/ssf-format): Functions from src/ssf/format.ts
- [utils/cell Functions](/xlsx-format/api-reference/functions/utils-cell): Functions from src/utils/cell.ts
- [write Functions](/xlsx-format/api-reference/functions/write): Functions from src/write.ts
- [Interfaces](/xlsx-format/api-reference/interfaces)
- [AOA2SheetOpts](/xlsx-format/api-reference/interfaces/aoa2sheetopts): Options for creating a worksheet from a 2D array (Array of Arrays)
- [AutoFilterInfo](/xlsx-format/api-reference/interfaces/autofilterinfo): AutoFilter definition for a worksheet
- [BookPropsResult](/xlsx-format/api-reference/interfaces/bookpropsresult): Result returned when read() is called with bookProps enabled.
- [BookSheetsAndPropsResult](/xlsx-format/api-reference/interfaces/booksheetsandpropsresult): Result returned when read() requests both sheet names and properties.
- [BookSheetsResult](/xlsx-format/api-reference/interfaces/booksheetsresult): Result returned when read() is called with bookSheets enabled.
- [CellAddress](/xlsx-format/api-reference/interfaces/celladdress): Zero-based cell address with column (c) and row (r) indices
- [CellAlignment](/xlsx-format/api-reference/interfaces/cellalignment): Cell alignment properties
- [CellBorder](/xlsx-format/api-reference/interfaces/cellborder): Border style properties for a cell
- [CellBorderSide](/xlsx-format/api-reference/interfaces/cellborderside): Border side descriptor
- [CellFill](/xlsx-format/api-reference/interfaces/cellfill): Fill style properties for a cell
- [CellFont](/xlsx-format/api-reference/interfaces/cellfont): Font style properties for a cell
- [CellObject](/xlsx-format/api-reference/interfaces/cellobject): Worksheet Cell Object containing value, format, formula, and metadata
- [CellStyle](/xlsx-format/api-reference/interfaces/cellstyle): Serializable XLSX cell style
- [ColInfo](/xlsx-format/api-reference/interfaces/colinfo): Column properties for worksheet column metadata
- [Comment](/xlsx-format/api-reference/interfaces/comment): A single comment entry within a cell's comment thread
- [Comments](/xlsx-format/api-reference/interfaces/comments): Array of comments attached to a cell, with optional visibility flag
- [CSV2SheetOpts](/xlsx-format/api-reference/interfaces/csv2sheetopts): Options for parsing CSV text into a worksheet.
- [DefinedName](/xlsx-format/api-reference/interfaces/definedname): Defined Name (named range or named formula)
- [FullProperties](/xlsx-format/api-reference/interfaces/fullproperties): Extended file properties (combines Core Properties with App-specific metadata)
- [HTML2SheetOpts](/xlsx-format/api-reference/interfaces/html2sheetopts): Options for parsing an HTML table into a worksheet.
- [Hyperlink](/xlsx-format/api-reference/interfaces/hyperlink): Hyperlink target and optional tooltip
- [JSON2SheetOpts](/xlsx-format/api-reference/interfaces/json2sheetopts): Options for creating a worksheet from an array of JSON objects
- [MarginInfo](/xlsx-format/api-reference/interfaces/margininfo): Page margin settings in inches
- [Properties](/xlsx-format/api-reference/interfaces/properties): Basic file properties from the OPC Core Properties part
- [ProtectInfo](/xlsx-format/api-reference/interfaces/protectinfo): Sheet protection settings controlling what users can do on a protected sheet
- [Range](/xlsx-format/api-reference/interfaces/range): Range defined by start (s) and end (e) cell addresses
- [ReadOptions](/xlsx-format/api-reference/interfaces/readoptions): Options for reading/parsing workbook files
- [RowInfo](/xlsx-format/api-reference/interfaces/rowinfo): Row properties for worksheet row metadata
- [Sheet](/xlsx-format/api-reference/interfaces/sheet): Base sheet object supporting both sparse and dense storage modes.
- [Sheet2CSVOpts](/xlsx-format/api-reference/interfaces/sheet2csvopts): Options for converting a worksheet to CSV
- [Sheet2HTMLOpts](/xlsx-format/api-reference/interfaces/sheet2htmlopts): Options for converting a worksheet to an HTML table string
- [Sheet2JSONOpts](/xlsx-format/api-reference/interfaces/sheet2jsonopts): Options for converting a worksheet to an array of JSON objects
- [SheetProps](/xlsx-format/api-reference/interfaces/sheetprops): Properties of a single sheet within the workbook
- [SheetView](/xlsx-format/api-reference/interfaces/sheetview): Frozen pane / sheet view metadata
- [StyleColor](/xlsx-format/api-reference/interfaces/stylecolor): RGB/ARGB color descriptor used in cell styles
- [WBProps](/xlsx-format/api-reference/interfaces/wbprops): Workbook-level attributes (sheets, names, views, properties)
- [WBView](/xlsx-format/api-reference/interfaces/wbview): Workbook view settings
- [WorkBook](/xlsx-format/api-reference/interfaces/workbook): Top-level Workbook object containing all sheets, properties, and metadata
- [WorkbookProperties](/xlsx-format/api-reference/interfaces/workbookproperties): Workbook-level calculation and date system properties
- [WorkSheet](/xlsx-format/api-reference/interfaces/worksheet): Worksheet object with column, row, merge, protection, and filter metadata
- [WorksheetCellBudgetOptions](/xlsx-format/api-reference/interfaces/worksheetcellbudgetoptions): Cumulative worksheet work limit shared by import and export APIs.
- [WriteOptions](/xlsx-format/api-reference/interfaces/writeoptions): Options for writing/serializing workbook files
- [Types](/xlsx-format/api-reference/types)
- [errors Types](/xlsx-format/api-reference/types/errors): Type definitions from src/errors.ts
- [types Types](/xlsx-format/api-reference/types/types): Type definitions from src/types.ts
- [version](/xlsx-format/api-reference/variables/version): Variable version
- [Getting Started](/xlsx-format/guide/getting-started)
- [Migration from SheetJS](/xlsx-format/guide/migration)
- [Security Considerations](/xlsx-format/guide/security)
- [Styled Workbooks](/xlsx-format/guide/styled-workbooks)
- [Why xlsx-format?](/xlsx-format/guide/why-xlsx-format)

## More

- [Full documentation](/xlsx-format/llms-full.txt): Complete documentation as one Markdown file.