Class ExportEngine

Main export engine class Provides a unified API for all export formats including multi-sheet Excel workbooks

Index

Constructors

Methods

createExporter CreateExporterAsync export getFileExtension getFormatCapabilities getMimeType getSupportedFormats supportsFormulas supportsMultiSheet supportsStyling toCSV toExcel toExcelMultiSheet toJSON

Constructors

constructor

new ExportEngine(): ExportEngine
Returns ExportEngine

Methods

`Static`createExporter

createExporter(
format: ExportFormat,
options?: Partial<ExportOptions>,
): BaseExporter
Create an exporter instance for the specified format (sync - csv/json only) For Excel format, use CreateExporterAsync() instead.
Parameters
- format: ExportFormat
- options: Partial<ExportOptions> = {}
Returns BaseExporter
- Defined in export-engine.ts:134

`Static`CreateExporterAsync

CreateExporterAsync(
format: ExportFormat,
options?: Partial<ExportOptions>,
): Promise<BaseExporter>
Create an exporter instance asynchronously (supports all formats including Excel)
Parameters
- format: ExportFormat
- options: Partial<ExportOptions> = {}
Returns Promise<BaseExporter>
- Defined in export-engine.ts:115

`Static`export

export(
data: ExportData,
options?: Partial<ExportOptions>,
): Promise<ExportResult>
Export data to the specified format
Parameters
- data: ExportData
  Array of data objects or arrays to export
- options: Partial<ExportOptions> = {}
  Export options including format, columns, sampling, etc.
Returns Promise<ExportResult>
Export result with buffer and metadata
- Defined in export-engine.ts:24

`Static`getFileExtension

getFileExtension(format: ExportFormat): string
Get file extension for a format
Parameters
- format: ExportFormat
Returns string
- Defined in export-engine.ts:166

`Static`getFormatCapabilities

getFormatCapabilities(
    format: ExportFormat,
): {
    conditionalFormatting: boolean;
    dataValidation: boolean;
    formulas: boolean;
    images: boolean;
    multiSheet: boolean;
    protection: boolean;
    styling: boolean;
}
Get format capabilities
Parameters
- format: ExportFormat
Returns {
    conditionalFormatting: boolean;
    dataValidation: boolean;
    formulas: boolean;
    images: boolean;
    multiSheet: boolean;
    protection: boolean;
    styling: boolean;
}
- Defined in export-engine.ts:196

`Static`getMimeType

getMimeType(format: ExportFormat): string
Get MIME type for a format
Parameters
- format: ExportFormat
Returns string
- Defined in export-engine.ts:157

`Static`getSupportedFormats

getSupportedFormats(): ExportFormat[]
Get supported export formats

Returns ExportFormat[]
- Defined in export-engine.ts:150

`Static`supportsFormulas

supportsFormulas(format: ExportFormat): boolean
Check if a format supports formulas
Parameters
- format: ExportFormat
Returns boolean
- Defined in export-engine.ts:182

`Static`supportsMultiSheet

supportsMultiSheet(format: ExportFormat): boolean
Check if a format supports multi-sheet export
Parameters
- format: ExportFormat
Returns boolean
- Defined in export-engine.ts:175

`Static`supportsStyling

supportsStyling(format: ExportFormat): boolean
Check if a format supports styling
Parameters
- format: ExportFormat
Returns boolean
- Defined in export-engine.ts:189

`Static`toCSV

toCSV(
data: ExportData,
options?: Omit<Partial<ExportOptions>, "format">,
): Promise<ExportResult>
Export to CSV format
Parameters
- data: ExportData
- options: Omit<Partial<ExportOptions>, "format"> = {}
Returns Promise<ExportResult>
- Defined in export-engine.ts:45

`Static`toExcel

toExcel(
data: ExportData,
options?: Omit<Partial<ExportOptions>, "format">,
): Promise<ExportResult>
Export to Excel format (single sheet)
Parameters
- data: ExportData
- options: Omit<Partial<ExportOptions>, "format"> = {}
Returns Promise<ExportResult>
- Defined in export-engine.ts:35

`Static`toExcelMultiSheet

toExcelMultiSheet(
    sheets: SheetDefinition[],
    options?: {
        calcOnSave?: boolean;
        defaultDateFormat?: string;
        defaultNumberFormat?: string;
        fileName?: string;
        metadata?: WorkbookMetadata;
    },
): Promise<ExportResult>
Create a multi-sheet Excel workbook
Parameters
- sheets: SheetDefinition[]
  Array of sheet definitions
- options: {
      calcOnSave?: boolean;
      defaultDateFormat?: string;
      defaultNumberFormat?: string;
      fileName?: string;
      metadata?: WorkbookMetadata;
  } = {}
  Additional workbook options
Returns Promise<ExportResult>
Export result with buffer and metadata
Example
```
const result = await ExportEngine.toExcelMultiSheet([
  {
    name: 'Sales Data',
    data: salesData,
    headerStyle: { font: { bold: true }, fill: { pattern: 'solid', fgColor: '4472C4' } }
  },
  {
    name: 'Summary',
    data: summaryData,
    formulas: [{ cell: 'B10', formula: 'SUM(B2:B9)' }]
  }
], {
  fileName: 'quarterly-report',
  metadata: { author: 'Sales Team', title: 'Q1 2024 Report' }
});
```
- Defined in export-engine.ts:87

`Static`toJSON

toJSON(
data: ExportData,
options?: Omit<Partial<ExportOptions>, "format">,
): Promise<ExportResult>
Export to JSON format
Parameters
- data: ExportData
- options: Omit<Partial<ExportOptions>, "format"> = {}
Returns Promise<ExportResult>
- Defined in export-engine.ts:55

Class ExportEngine

Index

Constructors

Methods

Constructors

constructor

Returns ExportEngine

Methods

StaticcreateExporter

Parameters

Returns BaseExporter

StaticCreateExporterAsync

Parameters

Returns Promise<BaseExporter>

Staticexport

Parameters

Returns Promise<ExportResult>

StaticgetFileExtension

Parameters

Returns string

StaticgetFormatCapabilities

Parameters

Returns { conditionalFormatting: boolean; dataValidation: boolean; formulas: boolean; images: boolean; multiSheet: boolean; protection: boolean; styling: boolean;}

StaticgetMimeType

Parameters

Returns string

StaticgetSupportedFormats

Returns ExportFormat[]

StaticsupportsFormulas

Parameters

Returns boolean

StaticsupportsMultiSheet

Parameters

Returns boolean

StaticsupportsStyling

Parameters

Returns boolean

StatictoCSV

Parameters

Returns Promise<ExportResult>

StatictoExcel

Parameters

Returns Promise<ExportResult>

StatictoExcelMultiSheet

Parameters

Returns Promise<ExportResult>

Example

StatictoJSON

Parameters

Returns Promise<ExportResult>

Settings

On This Page

`Static`createExporter

`Static`CreateExporterAsync

`Static`export

`Static`getFileExtension

`Static`getFormatCapabilities

Returns {
conditionalFormatting: boolean;
dataValidation: boolean;
formulas: boolean;
images: boolean;
multiSheet: boolean;
protection: boolean;
styling: boolean;
}

`Static`getMimeType

`Static`getSupportedFormats

`Static`supportsFormulas

`Static`supportsMultiSheet

`Static`supportsStyling

`Static`toCSV

`Static`toExcel

`Static`toExcelMultiSheet

`Static`toJSON