← All packages

API reference

@searsuite/sear-plugin-export-node

Node CSV and XLSX adapters for Workbook document states.

5 exportsderived from source

interfaceNodeCsvWorkbookImportOptionssource ↗
interface NodeCsvWorkbookImportOptions
propertysheetId
readonly sheetId?: string
propertysheetName
readonly sheetName?: string
propertyworkbookId
readonly workbookId: string
functionexportNodeCsvSheetsource ↗
exportNodeCsvSheet(state: WorkbookDocumentState<SheetDocumentState>, sheetId: string): string

Exports one Workbook sheet as CSV, preserving formula source text.

state: WorkbookDocumentState<SheetDocumentState>
sheetId: string
functionexportNodeXlsxWorkbooksource ↗
exportNodeXlsxWorkbook(state: WorkbookDocumentState<SheetDocumentState>): Promise<Uint8Array<ArrayBufferLike>>

Writes Workbook formula sources and scalar values to an XLSX buffer.

state: WorkbookDocumentState<SheetDocumentState>
functionimportNodeCsvWorkbooksource ↗
importNodeCsvWorkbook(text: string, options: NodeCsvWorkbookImportOptions): WorkbookDocumentState<SheetDocumentState>

Imports one CSV table as a single-sheet Workbook document.

text: string
options: NodeCsvWorkbookImportOptions
functionimportNodeXlsxWorkbooksource ↗
importNodeXlsxWorkbook(bytes: Uint8Array, workbookId: string): Promise<WorkbookDocumentState<SheetDocumentState>>

Reads values and formula sources from an XLSX buffer into a Workbook document.

bytes: Uint8Array
workbookId: string