@senlinz/import-export
Version:
import/export excel core
32 lines (31 loc) • 2.13 kB
TypeScript
import { ExcelColumnDefinition, ExcelDefinition, DynamicExcelImportOptions, DynamicExcelImportResult } from './ExcelDefinition';
declare const SUPPORTED_DATA_TYPES: readonly ["text", "number", "date", "image"];
type NormalizedDataType = typeof SUPPORTED_DATA_TYPES[number];
type NormalizedExcelColumnDefinition = Omit<ExcelColumnDefinition, 'dataType'> & {
dataType?: NormalizedDataType;
};
type NormalizedExcelDefinition = Omit<ExcelDefinition, 'columns'> & {
columns: NormalizedExcelColumnDefinition[];
maxFileSizeBytes: number;
escapeFormulas: boolean;
};
type NormalizedDynamicImportOptions = DynamicExcelImportOptions & {
maxFileSizeBytes: number;
};
type TestingUtils = {
normalizeDefinition(definition: ExcelDefinition): NormalizedExcelDefinition;
normalizeDynamicImportOptions(options?: DynamicExcelImportOptions): NormalizedDynamicImportOptions;
sanitizeTextCellValue(value: string, escapeFormulas?: boolean): string;
defaultMaxFileSizeBytes: number;
};
declare const testUtils: TestingUtils;
declare function _fromExcel<T>(definition: ExcelDefinition, buffer: Uint8Array): Promise<T[]>;
declare function _fromExcelDynamic(buffer: Uint8Array, options?: DynamicExcelImportOptions): Promise<DynamicExcelImportResult>;
declare function _toExcel<T>(definition: ExcelDefinition, data: T[]): Promise<Uint8Array<ArrayBufferLike>>;
declare function generateExcelTemplate(definition: ExcelDefinition): Promise<Uint8Array<ArrayBufferLike>>;
declare function downloadExcelTemplate(definition: ExcelDefinition): Promise<void>;
declare function download(data: Uint8Array | string, name: string, type?: string): void;
declare function importExcel<T>(definition: ExcelDefinition): Promise<T[]>;
declare function importExcelDynamic(options?: DynamicExcelImportOptions): Promise<DynamicExcelImportResult>;
declare function exportExcel<T>(definition: ExcelDefinition, data: T[]): Promise<void>;
export { importExcel, importExcelDynamic, exportExcel, downloadExcelTemplate, _fromExcel as fromExcel, _fromExcelDynamic as fromExcelDynamic, _toExcel as toExcel, generateExcelTemplate, download, testUtils };