API reference

The 659 functions, classes, and constants that @office-kit/xlsx exports, in 17 sections. It is generated from the source with typedoc on every build, so the signatures cannot drift from the package. Types are left to your editor.

For the conceptual map see the API overview. For code you can paste, see the cheatsheet and recipes.

• Loading & saving 17 exports Open a workbook from any source, write it back to any sink.
• Streaming readers & writers 2 exports createWriteOnlyWorkbook, loadWorkbookStream, and the iter-based row APIs.
• Errors 8 exports OpenXmlError and its subclasses, plus shared error options.
• Coordinates & ranges 48 exports A1 ↔ row/col conversion, range parsing, EMU and date helpers.
• Cell value inference 5 exports inferCellType, escape helpers, error code constants.
• Cells & values 33 exports Cell shape, formula helpers, inline rich-text composition.
• Tables & autoFilter 5 exports Excel Tables, table styles, and column-level autoFilter.
• Validation & formatting 3 exports Data validation rules and conditional formatting.
• Comments & hyperlinks 3 exports Legacy comments, threaded comments, and hyperlinks.
• Worksheet 143 exports Worksheet shape and the cell / row / column helpers built on top of it.
• Styles 116 exports Font, Fill, Border, Alignment, NumberFormat, Stylesheet.
• Drawings & images 34 exports Picture / chart anchors, image format detection.
• Charts 38 exports Legacy c: chart kinds plus the cx: chartex family.
• Chartsheets 2 exports Standalone chartsheet objects and their views.
• Workbook 51 exports Workbook root model: sheets, defined names, properties, calc settings.
• Low-level (XML / ZIP / schema / packaging) 150 exports XML reader / writer, OPC packaging, schema, ZIP. Reach in only when wiring custom parts.
• Other utilities 1 export Anything else exported from the public surface.