Skip to content

Class: XlsxWriter

Defined in: src/export/xlsx-writer.ts:29

Generates Excel (xlsx) files using exceljs. exceljs is an optional peer dependency — import fails gracefully with a helpful error message if not installed.

Constructors

Constructor

new XlsxWriter(columns, options?): XlsxWriter

Defined in: src/export/xlsx-writer.ts:34

Parameters

columns

ExportColumn[]

options?

XlsxWriterOptions = {}

Returns

XlsxWriter

Methods

addRow()

addRow(row): void

Defined in: src/export/xlsx-writer.ts:40

Add a data row.

Parameters

row

ExportRow

Returns

void


toBlob()

toBlob(): Promise<Blob>

Defined in: src/export/xlsx-writer.ts:73

Generate a Blob for download.

Returns

Promise<Blob>


toBuffer()

toBuffer(): Promise<ArrayBuffer>

Defined in: src/export/xlsx-writer.ts:45

Generate the xlsx as an ArrayBuffer.

Returns

Promise<ArrayBuffer>