@office-kit/xlsx spec

Reference

API reference

Every public export of @office-kit/xlsx, @office-kit/xlsx/streaming, and @office-kit/xlsx/node, organized by section. Generated from the source via typedoc and rendered inline so types stay in lockstep with the package.

01

Loading & saving

17

Open a workbook from any source, write it back to any sink.

02

Streaming readers & writers

2

createWriteOnlyWorkbook, loadWorkbookStream, and the iter-based row APIs.

03

Errors

6

OpenXmlError and its subclasses, plus shared error options.

04

Coordinates & ranges

48

A1 ↔ row/col conversion, range parsing, EMU and date helpers.

05

Cell value inference

5

inferCellType, escape helpers, error code constants.

06

Cells & values

29

Cell shape, formula helpers, inline rich-text composition.

07

Tables & autoFilter

5

Excel Tables, table styles, and column-level autoFilter.

08

Validation & formatting

3

Data validation rules and conditional formatting.

09

Comments & hyperlinks

2

Legacy comments, threaded comments, and hyperlinks.

10

Worksheet

127

Worksheet shape and the cell / row / column helpers built on top of it.

11

Styles

112

Font, Fill, Border, Alignment, NumberFormat, Stylesheet.

12

Drawings & images

30

Picture / chart anchors, image format detection.

13

Charts

38

Legacy `c:` chart kinds plus the `cx:` chartex family.

14

Chartsheets

2

Standalone chartsheet objects and their views.

15

Workbook

44

Workbook root model: sheets, defined names, properties, calc settings.

16

Low-level (XML / ZIP / schema / packaging)

150

XML reader / writer, OPC packaging, schema, ZIP. Reach in only when wiring custom parts.