ly-utils-lib 1.0.12 → 2.5.0

package/dist/index-YXWfKCK7.d.cts

@@ -0,0 +1,109 @@
+import * as XLSX from 'xlsx';
+
+/**
+ * Excel 工具模块
+ * 基于 xlsx 封装，提供常用的 Excel 处理功能
+ */
+
+interface ExcelExportOptions {
+    filename?: string;
+    sheetName?: string;
+    header?: Record<string, string>;
+}
+interface ExcelImportOptions {
+    header?: number;
+    raw?: boolean;
+    defval?: any;
+}
+/**
+ * 导出 Excel
+ * @param data 数据
+ * @param options 选项
+ */
+declare const exportExcel: <T extends Record<string, any>>(data: T[], options?: ExcelExportOptions) => void;
+/**
+ * 导出 Excel（多 Sheet）
+ * @param sheetsData Sheet 数据
+ * @param filename 文件名
+ */
+declare const exportMultiSheetExcel: (sheetsData: Array<{
+    name: string;
+    data: Record<string, any>[];
+    header?: Record<string, string>;
+}>, filename?: string) => void;
+/**
+ * 导入 Excel
+ * @param file 文件
+ * @param options 选项
+ */
+declare const importExcel: <T = Record<string, any>>(file: File | ArrayBuffer, options?: ExcelImportOptions) => Promise<T[]>;
+/**
+ * 导入 Excel（所有 Sheet）
+ * @param file 文件
+ * @param options 选项
+ */
+declare const importAllSheetsExcel: <T = Record<string, any>>(file: File | ArrayBuffer, options?: ExcelImportOptions) => Promise<Record<string, T[]>>;
+/**
+ * 导出 Excel（使用自定义表头）
+ * @param data 数据
+ * @param headers 表头
+ * @param filename 文件名
+ * @param sheetName Sheet 名称
+ */
+declare const exportExcelWithHeaders: (data: Record<string, any>[], headers: {
+    key: string;
+    label: string;
+}[], filename?: string, sheetName?: string) => void;
+/**
+ * 导出 Excel（设置列宽）
+ * @param data 数据
+ * @param columnWidths 列宽
+ * @param options 其他选项
+ */
+declare const exportExcelWithColumnWidths: (data: Record<string, any>[], columnWidths: {
+    wch?: number;
+    wpx?: number;
+    width?: number;
+}[], options?: ExcelExportOptions) => void;
+/**
+ * 导出 Excel（合并单元格）
+ * @param data 数据
+ * @param merges 合并区域
+ * @param options 其他选项
+ */
+declare const exportExcelWithMerges: (data: Record<string, any>[], merges: XLSX.Range[], options?: ExcelExportOptions) => void;
+/**
+ * 获取 Excel 的 Sheet 列表
+ * @param file 文件
+ */
+declare const getSheetNames: (file: File | ArrayBuffer) => Promise<string[]>;
+/**
+ * 将 HTML 表格导出为 Excel
+ * @param tableElement 表格元素
+ * @param filename 文件名
+ */
+declare const exportTableToExcel: (tableElement: HTMLTableElement, filename?: string) => void;
+/**
+ * 将 Excel 转换为 HTML 表格
+ * @param file 文件
+ * @param sheetIndex Sheet 索引
+ */
+declare const excelToTable: (file: File, sheetIndex?: number) => Promise<string>;
+
+type index_ExcelExportOptions = ExcelExportOptions;
+type index_ExcelImportOptions = ExcelImportOptions;
+declare const index_excelToTable: typeof excelToTable;
+declare const index_exportExcel: typeof exportExcel;
+declare const index_exportExcelWithColumnWidths: typeof exportExcelWithColumnWidths;
+declare const index_exportExcelWithHeaders: typeof exportExcelWithHeaders;
+declare const index_exportExcelWithMerges: typeof exportExcelWithMerges;
+declare const index_exportMultiSheetExcel: typeof exportMultiSheetExcel;
+declare const index_exportTableToExcel: typeof exportTableToExcel;
+declare const index_getSheetNames: typeof getSheetNames;
+declare const index_importAllSheetsExcel: typeof importAllSheetsExcel;
+declare const index_importExcel: typeof importExcel;
+declare namespace index {
+  export { type index_ExcelExportOptions as ExcelExportOptions, type index_ExcelImportOptions as ExcelImportOptions, index_excelToTable as excelToTable, index_exportExcel as exportExcel, index_exportExcelWithColumnWidths as exportExcelWithColumnWidths, index_exportExcelWithHeaders as exportExcelWithHeaders, index_exportExcelWithMerges as exportExcelWithMerges, index_exportMultiSheetExcel as exportMultiSheetExcel, index_exportTableToExcel as exportTableToExcel, index_getSheetNames as getSheetNames, index_importAllSheetsExcel as importAllSheetsExcel, index_importExcel as importExcel };
+}
+
+export { type ExcelExportOptions as E, type ExcelImportOptions as a, exportExcel as b, exportExcelWithColumnWidths as c, exportExcelWithHeaders as d, excelToTable as e, exportExcelWithMerges as f, exportMultiSheetExcel as g, exportTableToExcel as h, index as i, getSheetNames as j, importAllSheetsExcel as k, importExcel as l };

package/dist/index-YXWfKCK7.d.ts

@@ -0,0 +1,109 @@
+import * as XLSX from 'xlsx';
+
+/**
+ * Excel 工具模块
+ * 基于 xlsx 封装，提供常用的 Excel 处理功能
+ */
+
+interface ExcelExportOptions {
+    filename?: string;
+    sheetName?: string;
+    header?: Record<string, string>;
+}
+interface ExcelImportOptions {
+    header?: number;
+    raw?: boolean;
+    defval?: any;
+}
+/**
+ * 导出 Excel
+ * @param data 数据
+ * @param options 选项
+ */
+declare const exportExcel: <T extends Record<string, any>>(data: T[], options?: ExcelExportOptions) => void;
+/**
+ * 导出 Excel（多 Sheet）
+ * @param sheetsData Sheet 数据
+ * @param filename 文件名
+ */
+declare const exportMultiSheetExcel: (sheetsData: Array<{
+    name: string;
+    data: Record<string, any>[];
+    header?: Record<string, string>;
+}>, filename?: string) => void;
+/**
+ * 导入 Excel
+ * @param file 文件
+ * @param options 选项
+ */
+declare const importExcel: <T = Record<string, any>>(file: File | ArrayBuffer, options?: ExcelImportOptions) => Promise<T[]>;
+/**
+ * 导入 Excel（所有 Sheet）
+ * @param file 文件
+ * @param options 选项
+ */
+declare const importAllSheetsExcel: <T = Record<string, any>>(file: File | ArrayBuffer, options?: ExcelImportOptions) => Promise<Record<string, T[]>>;
+/**
+ * 导出 Excel（使用自定义表头）
+ * @param data 数据
+ * @param headers 表头
+ * @param filename 文件名
+ * @param sheetName Sheet 名称
+ */
+declare const exportExcelWithHeaders: (data: Record<string, any>[], headers: {
+    key: string;
+    label: string;
+}[], filename?: string, sheetName?: string) => void;
+/**
+ * 导出 Excel（设置列宽）
+ * @param data 数据
+ * @param columnWidths 列宽
+ * @param options 其他选项
+ */
+declare const exportExcelWithColumnWidths: (data: Record<string, any>[], columnWidths: {
+    wch?: number;
+    wpx?: number;
+    width?: number;
+}[], options?: ExcelExportOptions) => void;
+/**
+ * 导出 Excel（合并单元格）
+ * @param data 数据
+ * @param merges 合并区域
+ * @param options 其他选项
+ */
+declare const exportExcelWithMerges: (data: Record<string, any>[], merges: XLSX.Range[], options?: ExcelExportOptions) => void;
+/**
+ * 获取 Excel 的 Sheet 列表
+ * @param file 文件
+ */
+declare const getSheetNames: (file: File | ArrayBuffer) => Promise<string[]>;
+/**
+ * 将 HTML 表格导出为 Excel
+ * @param tableElement 表格元素
+ * @param filename 文件名
+ */
+declare const exportTableToExcel: (tableElement: HTMLTableElement, filename?: string) => void;
+/**
+ * 将 Excel 转换为 HTML 表格
+ * @param file 文件
+ * @param sheetIndex Sheet 索引
+ */
+declare const excelToTable: (file: File, sheetIndex?: number) => Promise<string>;
+
+type index_ExcelExportOptions = ExcelExportOptions;
+type index_ExcelImportOptions = ExcelImportOptions;
+declare const index_excelToTable: typeof excelToTable;
+declare const index_exportExcel: typeof exportExcel;
+declare const index_exportExcelWithColumnWidths: typeof exportExcelWithColumnWidths;
+declare const index_exportExcelWithHeaders: typeof exportExcelWithHeaders;
+declare const index_exportExcelWithMerges: typeof exportExcelWithMerges;
+declare const index_exportMultiSheetExcel: typeof exportMultiSheetExcel;
+declare const index_exportTableToExcel: typeof exportTableToExcel;
+declare const index_getSheetNames: typeof getSheetNames;
+declare const index_importAllSheetsExcel: typeof importAllSheetsExcel;
+declare const index_importExcel: typeof importExcel;
+declare namespace index {
+  export { type index_ExcelExportOptions as ExcelExportOptions, type index_ExcelImportOptions as ExcelImportOptions, index_excelToTable as excelToTable, index_exportExcel as exportExcel, index_exportExcelWithColumnWidths as exportExcelWithColumnWidths, index_exportExcelWithHeaders as exportExcelWithHeaders, index_exportExcelWithMerges as exportExcelWithMerges, index_exportMultiSheetExcel as exportMultiSheetExcel, index_exportTableToExcel as exportTableToExcel, index_getSheetNames as getSheetNames, index_importAllSheetsExcel as importAllSheetsExcel, index_importExcel as importExcel };
+}
+
+export { type ExcelExportOptions as E, type ExcelImportOptions as a, exportExcel as b, exportExcelWithColumnWidths as c, exportExcelWithHeaders as d, excelToTable as e, exportExcelWithMerges as f, exportMultiSheetExcel as g, exportTableToExcel as h, index as i, getSheetNames as j, importAllSheetsExcel as k, importExcel as l };