Skip to content

write Functions

Functions from src/write.ts

Functions exported from src/write.ts

write

function write(wb: WorkBook, opts?: BinaryWriteOptions | SpreadsheetWriteOptions): Promise<Uint8Array<ArrayBufferLike>>

Parameters

NameTypeDescription
wbWorkBookWorkBook object to serialize
opts (optional)`BinaryWriteOptionsSpreadsheetWriteOptions`

Returns

Promise<Uint8Array<ArrayBufferLike>>

A string for base64 or text output; otherwise a portable Uint8Array

function write(wb: WorkBook, opts: Base64WriteOptions | TextWriteOptions): Promise<string>

Parameters

NameTypeDescription
wbWorkBookWorkBook object to serialize
opts`Base64WriteOptionsTextWriteOptions`

Returns

Promise<string>

A string for base64 or text output; otherwise a portable Uint8Array

function write(wb: WorkBook, opts?: WriteOptions): Promise<WriteResult>

Parameters

NameTypeDescription
wbWorkBookWorkBook object to serialize
opts (optional)WriteOptionsWrite options controlling output format and behavior

Returns

Promise<WriteResult>

A string for base64 or text output; otherwise a portable Uint8Array