@sheetwrite/coreinterface
Shared options passed to every registered table and workbook XLSX backend.
- Package
@sheetwrite/core- Source
packages/core/src/export.ts#L407
Members 4
signal Abort before or between bounded codec operations.
signal?: AbortSignal;maxCells Cells accounted by the active conversion path; defaults to 1,000,000.
maxCells?: number;resourceLimits Positive overrides for every XLSX resource dimension except maxCells.
resourceLimits?: Partial<Omit<XlsxResourceLimitsinterface XlsxResourceLimits {
maxInputBytes: number;
maxOutputBytes: number;
maxArchiveEntries: number;
maxEntryUncompressedBytes: number;
maxTotalUncompressedBytes: number;
maxCompressionRatio: number;
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxCells: number;
maxMerges: number;
maxSharedStrings: number;
maxStyles: number;
maxXmlElements: number;
// … 4 more lines — see the API reference
}interface XlsxResourceLimits {
maxInputBytes: number;
maxOutputBytes: number;
maxArchiveEntries: number;
maxEntryUncompressedBytes: number;
maxTotalUncompressedBytes: number;
maxCompressionRatio: number;
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxCells: number;
maxMerges: number;
maxSharedStrings: number;
maxStyles: number;
maxXmlElements: number;
// … 4 more lines — see the API reference
}interface XlsxResourceLimits {
maxInputBytes: number;
maxOutputBytes: number;
maxArchiveEntries: number;
maxEntryUncompressedBytes: number;
maxTotalUncompressedBytes: number;
maxCompressionRatio: number;
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxCells: number;
maxMerges: number;
maxSharedStrings: number;
maxStyles: number;
maxXmlElements: number;
maxXmlDepth: number;
maxXmlAttributesPerElement: number;
maxXmlTextBytes: number;
}Resource dimensions bounded by every XLSX import and export path.API reference →, "maxCells">>;onWarning
onWarning?: (warning: XlsxWorkbookWarninginterface XlsxWorkbookWarning {
code:
| "boolean-literal"
| "rich-text"
| "hyperlink"
| "unsupported-cell-value"
| "unsupported-feature"
| "external-relationship"
| "external-formula"
| "format-loss"
| "validation-loss"
| "invalid-metadata";
message: string;
sheet?: string;
cell?: string;
// … 2 more lines — see the API reference
}interface XlsxWorkbookWarning {
code:
| "boolean-literal"
| "rich-text"
| "hyperlink"
| "unsupported-cell-value"
| "unsupported-feature"
| "external-relationship"
| "external-formula"
| "format-loss"
| "validation-loss"
| "invalid-metadata";
message: string;
sheet?: string;
cell?: string;
// … 2 more lines — see the API reference
}interface XlsxWorkbookWarning {
code:
| "boolean-literal"
| "rich-text"
| "hyperlink"
| "unsupported-cell-value"
| "unsupported-feature"
| "external-relationship"
| "external-formula"
| "format-loss"
| "validation-loss"
| "invalid-metadata";
message: string;
sheet?: string;
cell?: string;
part?: string;
}Structured fidelity warning emitted during XLSX conversion.API reference →) => void;Declaration
View full TypeScript declaration
export interface XlsxWorkbookOptions { signal?: AbortSignal; maxCells?: number; resourceLimits?: Partial<Omit<XlsxResourceLimitsinterface XlsxResourceLimits {
maxInputBytes: number;
maxOutputBytes: number;
maxArchiveEntries: number;
maxEntryUncompressedBytes: number;
maxTotalUncompressedBytes: number;
maxCompressionRatio: number;
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxCells: number;
maxMerges: number;
maxSharedStrings: number;
maxStyles: number;
maxXmlElements: number;
// … 4 more lines — see the API reference
}interface XlsxResourceLimits {
maxInputBytes: number;
maxOutputBytes: number;
maxArchiveEntries: number;
maxEntryUncompressedBytes: number;
maxTotalUncompressedBytes: number;
maxCompressionRatio: number;
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxCells: number;
maxMerges: number;
maxSharedStrings: number;
maxStyles: number;
maxXmlElements: number;
// … 4 more lines — see the API reference
}interface XlsxResourceLimits {
maxInputBytes: number;
maxOutputBytes: number;
maxArchiveEntries: number;
maxEntryUncompressedBytes: number;
maxTotalUncompressedBytes: number;
maxCompressionRatio: number;
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxCells: number;
maxMerges: number;
maxSharedStrings: number;
maxStyles: number;
maxXmlElements: number;
maxXmlDepth: number;
maxXmlAttributesPerElement: number;
maxXmlTextBytes: number;
}Resource dimensions bounded by every XLSX import and export path.API reference →, "maxCells">>; onWarning?: (warning: XlsxWorkbookWarninginterface XlsxWorkbookWarning {
code:
| "boolean-literal"
| "rich-text"
| "hyperlink"
| "unsupported-cell-value"
| "unsupported-feature"
| "external-relationship"
| "external-formula"
| "format-loss"
| "validation-loss"
| "invalid-metadata";
message: string;
sheet?: string;
cell?: string;
// … 2 more lines — see the API reference
}interface XlsxWorkbookWarning {
code:
| "boolean-literal"
| "rich-text"
| "hyperlink"
| "unsupported-cell-value"
| "unsupported-feature"
| "external-relationship"
| "external-formula"
| "format-loss"
| "validation-loss"
| "invalid-metadata";
message: string;
sheet?: string;
cell?: string;
// … 2 more lines — see the API reference
}interface XlsxWorkbookWarning {
code:
| "boolean-literal"
| "rich-text"
| "hyperlink"
| "unsupported-cell-value"
| "unsupported-feature"
| "external-relationship"
| "external-formula"
| "format-loss"
| "validation-loss"
| "invalid-metadata";
message: string;
sheet?: string;
cell?: string;
part?: string;
}Structured fidelity warning emitted during XLSX conversion.API reference →) => void;}