@tanwan/utils 1.0.0 → 1.2.0

package/dist/downloadFile.d.cts

@@ -0,0 +1,20 @@
+//#region src/business/downloadFile/index.d.ts
+/**
+* 下载文件（支持 URL 或 Blob）
+*
+* @param source - 文件 URL 地址或 Blob 对象
+* @param filename - 下载文件名
+*
+* @example
+* ```ts
+* import downloadFile from '@tanwan/utils/downloadFile'
+* // 下载 URL
+* downloadFile('https://example.com/file.pdf', 'document.pdf')
+*
+* // 下载 Blob
+* const blob = new Blob(['hello'], { type: 'text/plain' })
+* downloadFile(blob, 'hello.txt')
+* ```
+*/
+declare function downloadFile(source: string | Blob, filename: string): void;
+export = downloadFile;

package/dist/downloadFile.d.ts

@@ -0,0 +1,21 @@
+//#region src/business/downloadFile/index.d.ts
+/**
+* 下载文件（支持 URL 或 Blob）
+*
+* @param source - 文件 URL 地址或 Blob 对象
+* @param filename - 下载文件名
+*
+* @example
+* ```ts
+* import downloadFile from '@tanwan/utils/downloadFile'
+* // 下载 URL
+* downloadFile('https://example.com/file.pdf', 'document.pdf')
+*
+* // 下载 Blob
+* const blob = new Blob(['hello'], { type: 'text/plain' })
+* downloadFile(blob, 'hello.txt')
+* ```
+*/
+declare function downloadFile(source: string | Blob, filename: string): void;
+//#endregion
+export { downloadFile as default };

package/dist/downloadFile.js

@@ -0,0 +1,31 @@
+//#region src/business/downloadFile/index.ts
+/**
+* 下载文件（支持 URL 或 Blob）
+*
+* @param source - 文件 URL 地址或 Blob 对象
+* @param filename - 下载文件名
+*
+* @example
+* ```ts
+* import downloadFile from '@tanwan/utils/downloadFile'
+* // 下载 URL
+* downloadFile('https://example.com/file.pdf', 'document.pdf')
+*
+* // 下载 Blob
+* const blob = new Blob(['hello'], { type: 'text/plain' })
+* downloadFile(blob, 'hello.txt')
+* ```
+*/
+function downloadFile(source, filename) {
+	const url = typeof source === "string" ? source : URL.createObjectURL(source);
+	const a = document.createElement("a");
+	a.href = url;
+	a.download = filename;
+	a.style.display = "none";
+	document.body.appendChild(a);
+	a.click();
+	document.body.removeChild(a);
+	if (source instanceof Blob) URL.revokeObjectURL(url);
+}
+//#endregion
+export { downloadFile as default };

package/dist/encodeBase64.cjs

@@ -0,0 +1,20 @@
+//#region src/business/encodeBase64/index.ts
+/**
+* Base64 编码（支持中文）
+*
+* @param str - 待编码的字符串
+* @returns Base64 编码结果
+*
+* @example
+* ```ts
+* import { encodeBase64, decodeBase64 } from '@tanwan/utils'
+* encodeBase64('Hello')       // 'SGVsbG8='
+* encodeBase64('你好')        // '5L2g5aW9'
+* decodeBase64('5L2g5aW9')   // '你好'
+* ```
+*/
+function encodeBase64(str) {
+	return btoa(unescape(encodeURIComponent(str)));
+}
+//#endregion
+module.exports = encodeBase64;

package/dist/encodeBase64.d.cts

@@ -0,0 +1,17 @@
+//#region src/business/encodeBase64/index.d.ts
+/**
+* Base64 编码（支持中文）
+*
+* @param str - 待编码的字符串
+* @returns Base64 编码结果
+*
+* @example
+* ```ts
+* import { encodeBase64, decodeBase64 } from '@tanwan/utils'
+* encodeBase64('Hello')       // 'SGVsbG8='
+* encodeBase64('你好')        // '5L2g5aW9'
+* decodeBase64('5L2g5aW9')   // '你好'
+* ```
+*/
+declare function encodeBase64(str: string): string;
+export = encodeBase64;

package/dist/encodeBase64.d.ts

@@ -0,0 +1,18 @@
+//#region src/business/encodeBase64/index.d.ts
+/**
+* Base64 编码（支持中文）
+*
+* @param str - 待编码的字符串
+* @returns Base64 编码结果
+*
+* @example
+* ```ts
+* import { encodeBase64, decodeBase64 } from '@tanwan/utils'
+* encodeBase64('Hello')       // 'SGVsbG8='
+* encodeBase64('你好')        // '5L2g5aW9'
+* decodeBase64('5L2g5aW9')   // '你好'
+* ```
+*/
+declare function encodeBase64(str: string): string;
+//#endregion
+export { encodeBase64 as default };

package/dist/encodeBase64.js

@@ -0,0 +1,20 @@
+//#region src/business/encodeBase64/index.ts
+/**
+* Base64 编码（支持中文）
+*
+* @param str - 待编码的字符串
+* @returns Base64 编码结果
+*
+* @example
+* ```ts
+* import { encodeBase64, decodeBase64 } from '@tanwan/utils'
+* encodeBase64('Hello')       // 'SGVsbG8='
+* encodeBase64('你好')        // '5L2g5aW9'
+* decodeBase64('5L2g5aW9')   // '你好'
+* ```
+*/
+function encodeBase64(str) {
+	return btoa(unescape(encodeURIComponent(str)));
+}
+//#endregion
+export { encodeBase64 as default };

package/dist/{array/flatten.cjs → flatten.cjs}

@@ -3,7 +3,7 @@
 * 数组扁平化
 * @example
 * ```ts
-* import flatten from '@tw/utils/flatten'
+* import flatten from '@tanwan/utils/flatten'
 * flatten([1, [2, [3, 4]]]) // [1, 2, 3, 4]
 * flatten([1, [2, 3]], 1) // [1, 2, 3]
 * ```

package/dist/{array/flatten.d.cts → flatten.d.cts}

@@ -3,11 +3,10 @@
 * 数组扁平化
 * @example
 * ```ts
-* import flatten from '@tw/utils/flatten'
+* import flatten from '@tanwan/utils/flatten'
 * flatten([1, [2, [3, 4]]]) // [1, 2, 3, 4]
 * flatten([1, [2, 3]], 1) // [1, 2, 3]
 * ```
 */
 declare function flatten<T>(arr: unknown[], depth?: number): T[];
-export = flatten;
-//# sourceMappingURL=flatten.d.cts.map
+export = flatten;

package/dist/{array/flatten.d.ts → flatten.d.ts}

@@ -3,12 +3,11 @@
 * 数组扁平化
 * @example
 * ```ts
-* import flatten from '@tw/utils/flatten'
+* import flatten from '@tanwan/utils/flatten'
 * flatten([1, [2, [3, 4]]]) // [1, 2, 3, 4]
 * flatten([1, [2, 3]], 1) // [1, 2, 3]
 * ```
 */
 declare function flatten<T>(arr: unknown[], depth?: number): T[];
 //#endregion
-export { flatten as default };
-//# sourceMappingURL=flatten.d.ts.map
+export { flatten as default };

package/dist/{array/flatten.js → flatten.js}

@@ -3,7 +3,7 @@
 * 数组扁平化
 * @example
 * ```ts
-* import flatten from '@tw/utils/flatten'
+* import flatten from '@tanwan/utils/flatten'
 * flatten([1, [2, [3, 4]]]) // [1, 2, 3, 4]
 * flatten([1, [2, 3]], 1) // [1, 2, 3]
 * ```
@@ -17,5 +17,3 @@ function flatten(arr, depth = Infinity) {
 }
 //#endregion
 export { flatten as default };
-
-//# sourceMappingURL=flatten.js.map

package/dist/formatBankCard.cjs

@@ -0,0 +1,19 @@
+//#region src/business/formatBankCard/index.ts
+/**
+* 银行卡号格式化，每 4 位用空格分隔
+*
+* @param cardNo - 银行卡号
+* @returns 格式化后的卡号
+*
+* @example
+* ```ts
+* import formatBankCard from '@tanwan/utils/formatBankCard'
+* formatBankCard('6222021234567890')
+* // '6222 0212 3456 7890'
+* ```
+*/
+function formatBankCard(cardNo) {
+	return cardNo.replace(/(\d{4})(?=\d)/g, "$1 ");
+}
+//#endregion
+module.exports = formatBankCard;

package/dist/formatBankCard.d.cts

@@ -0,0 +1,16 @@
+//#region src/business/formatBankCard/index.d.ts
+/**
+* 银行卡号格式化，每 4 位用空格分隔
+*
+* @param cardNo - 银行卡号
+* @returns 格式化后的卡号
+*
+* @example
+* ```ts
+* import formatBankCard from '@tanwan/utils/formatBankCard'
+* formatBankCard('6222021234567890')
+* // '6222 0212 3456 7890'
+* ```
+*/
+declare function formatBankCard(cardNo: string): string;
+export = formatBankCard;

package/dist/formatBankCard.d.ts

@@ -0,0 +1,17 @@
+//#region src/business/formatBankCard/index.d.ts
+/**
+* 银行卡号格式化，每 4 位用空格分隔
+*
+* @param cardNo - 银行卡号
+* @returns 格式化后的卡号
+*
+* @example
+* ```ts
+* import formatBankCard from '@tanwan/utils/formatBankCard'
+* formatBankCard('6222021234567890')
+* // '6222 0212 3456 7890'
+* ```
+*/
+declare function formatBankCard(cardNo: string): string;
+//#endregion
+export { formatBankCard as default };

package/dist/formatBankCard.js

@@ -0,0 +1,19 @@
+//#region src/business/formatBankCard/index.ts
+/**
+* 银行卡号格式化，每 4 位用空格分隔
+*
+* @param cardNo - 银行卡号
+* @returns 格式化后的卡号
+*
+* @example
+* ```ts
+* import formatBankCard from '@tanwan/utils/formatBankCard'
+* formatBankCard('6222021234567890')
+* // '6222 0212 3456 7890'
+* ```
+*/
+function formatBankCard(cardNo) {
+	return cardNo.replace(/(\d{4})(?=\d)/g, "$1 ");
+}
+//#endregion
+export { formatBankCard as default };

package/dist/formatCurrency.cjs

@@ -0,0 +1,7 @@
+//#region src/business/formatCurrency/index.ts
+function formatCurrency(amount, options = {}) {
+	const { unit = "cent", symbol = "¥", decimals = 2 } = options;
+	return `${symbol}${(unit === "cent" ? amount / 100 : amount).toFixed(decimals).replace(/\B(?=(\d{3})+(?!\d))/g, ",")}`;
+}
+//#endregion
+module.exports = formatCurrency;

package/dist/formatCurrency.d.cts

@@ -0,0 +1,27 @@
+//#region src/business/formatCurrency/index.d.ts
+/**
+* 金额格式化
+*
+* @param amount - 金额（分，整数），或元（当 unit 为 'yuan' 时）
+* @param options - 配置项
+* @param options.unit - 单位，`'cent'`（分，默认）| `'yuan'`（元）
+* @param options.symbol - 货币符号，默认 `'¥'`
+* @param options.decimals - 小数位数，默认 2
+* @returns 格式化后的金额字符串
+*
+* @example
+* ```ts
+* import formatCurrency from '@tanwan/utils/formatCurrency'
+* formatCurrency(1234567)          // '¥12,345.67'（分 → 元）
+* formatCurrency(12345, { unit: 'yuan' })   // '¥12,345.00'
+* formatCurrency(1234567, { symbol: '$' })  // '$12,345.67'
+* formatCurrency(1234567, { decimals: 0 })  // '¥12,346'
+* ```
+*/
+interface FormatCurrencyOptions {
+  unit?: "cent" | "yuan";
+  symbol?: string;
+  decimals?: number;
+}
+declare function formatCurrency(amount: number, options?: FormatCurrencyOptions): string;
+export = formatCurrency;

package/dist/formatCurrency.d.ts

@@ -0,0 +1,28 @@
+//#region src/business/formatCurrency/index.d.ts
+/**
+* 金额格式化
+*
+* @param amount - 金额（分，整数），或元（当 unit 为 'yuan' 时）
+* @param options - 配置项
+* @param options.unit - 单位，`'cent'`（分，默认）| `'yuan'`（元）
+* @param options.symbol - 货币符号，默认 `'¥'`
+* @param options.decimals - 小数位数，默认 2
+* @returns 格式化后的金额字符串
+*
+* @example
+* ```ts
+* import formatCurrency from '@tanwan/utils/formatCurrency'
+* formatCurrency(1234567)          // '¥12,345.67'（分 → 元）
+* formatCurrency(12345, { unit: 'yuan' })   // '¥12,345.00'
+* formatCurrency(1234567, { symbol: '$' })  // '$12,345.67'
+* formatCurrency(1234567, { decimals: 0 })  // '¥12,346'
+* ```
+*/
+interface FormatCurrencyOptions {
+  unit?: "cent" | "yuan";
+  symbol?: string;
+  decimals?: number;
+}
+declare function formatCurrency(amount: number, options?: FormatCurrencyOptions): string;
+//#endregion
+export { formatCurrency as default };

package/dist/formatCurrency.js

@@ -0,0 +1,7 @@
+//#region src/business/formatCurrency/index.ts
+function formatCurrency(amount, options = {}) {
+	const { unit = "cent", symbol = "¥", decimals = 2 } = options;
+	return `${symbol}${(unit === "cent" ? amount / 100 : amount).toFixed(decimals).replace(/\B(?=(\d{3})+(?!\d))/g, ",")}`;
+}
+//#endregion
+export { formatCurrency as default };

package/dist/{date/formatDate.cjs → formatDate.cjs}

@@ -3,7 +3,7 @@
 * 格式化日期
 * @example
 * ```ts
-* import formatDate from '@tw/utils/formatDate'
+* import formatDate from '@tanwan/utils/formatDate'
 * formatDate(new Date('2024-01-01'), 'yyyy-MM-dd') // '2024-01-01'
 * formatDate(1609459200000, 'yyyy/MM/dd HH:mm') // '2021/01/01 08:00'
 * ```

package/dist/{date/formatDate.d.cts → formatDate.d.cts}

@@ -3,11 +3,10 @@
 * 格式化日期
 * @example
 * ```ts
-* import formatDate from '@tw/utils/formatDate'
+* import formatDate from '@tanwan/utils/formatDate'
 * formatDate(new Date('2024-01-01'), 'yyyy-MM-dd') // '2024-01-01'
 * formatDate(1609459200000, 'yyyy/MM/dd HH:mm') // '2021/01/01 08:00'
 * ```
 */
 declare function formatDate(date: number | string | Date, fmt?: string): string;
-export = formatDate;
-//# sourceMappingURL=formatDate.d.cts.map
+export = formatDate;

package/dist/{date/formatDate.d.ts → formatDate.d.ts}

@@ -3,12 +3,11 @@
 * 格式化日期
 * @example
 * ```ts
-* import formatDate from '@tw/utils/formatDate'
+* import formatDate from '@tanwan/utils/formatDate'
 * formatDate(new Date('2024-01-01'), 'yyyy-MM-dd') // '2024-01-01'
 * formatDate(1609459200000, 'yyyy/MM/dd HH:mm') // '2021/01/01 08:00'
 * ```
 */
 declare function formatDate(date: number | string | Date, fmt?: string): string;
 //#endregion
-export { formatDate as default };
-//# sourceMappingURL=formatDate.d.ts.map
+export { formatDate as default };

package/dist/{date/formatDate.js → formatDate.js}

@@ -3,7 +3,7 @@
 * 格式化日期
 * @example
 * ```ts
-* import formatDate from '@tw/utils/formatDate'
+* import formatDate from '@tanwan/utils/formatDate'
 * formatDate(new Date('2024-01-01'), 'yyyy-MM-dd') // '2024-01-01'
 * formatDate(1609459200000, 'yyyy/MM/dd HH:mm') // '2021/01/01 08:00'
 * ```
@@ -36,5 +36,3 @@ function formatDate(date, fmt = "yyyy-MM-dd HH:mm:ss") {
 }
 //#endregion
 export { formatDate as default };
-
-//# sourceMappingURL=formatDate.js.map

package/dist/formatFileSize.cjs

@@ -0,0 +1,33 @@
+//#region src/business/formatFileSize/index.ts
+/**
+* 文件大小格式化
+*
+* @param bytes - 字节数
+* @param decimals - 小数位数，默认 2
+* @returns 格式化后的文件大小字符串
+*
+* @example
+* ```ts
+* import formatFileSize from '@tanwan/utils/formatFileSize'
+* formatFileSize(0)           // '0 B'
+* formatFileSize(1024)        // '1 KB'
+* formatFileSize(1536000)     // '1.46 MB'
+* formatFileSize(1073741824)  // '1 GB'
+* ```
+*/
+function formatFileSize(bytes, decimals = 2) {
+	if (bytes === 0) return "0 B";
+	const units = [
+		"B",
+		"KB",
+		"MB",
+		"GB",
+		"TB",
+		"PB"
+	];
+	const k = 1024;
+	const i = Math.floor(Math.log(bytes) / Math.log(k));
+	return `${Number.parseFloat((bytes / k ** i).toFixed(decimals))} ${units[i]}`;
+}
+//#endregion
+module.exports = formatFileSize;

package/dist/formatFileSize.d.cts

@@ -0,0 +1,19 @@
+//#region src/business/formatFileSize/index.d.ts
+/**
+* 文件大小格式化
+*
+* @param bytes - 字节数
+* @param decimals - 小数位数，默认 2
+* @returns 格式化后的文件大小字符串
+*
+* @example
+* ```ts
+* import formatFileSize from '@tanwan/utils/formatFileSize'
+* formatFileSize(0)           // '0 B'
+* formatFileSize(1024)        // '1 KB'
+* formatFileSize(1536000)     // '1.46 MB'
+* formatFileSize(1073741824)  // '1 GB'
+* ```
+*/
+declare function formatFileSize(bytes: number, decimals?: number): string;
+export = formatFileSize;

package/dist/formatFileSize.d.ts

@@ -0,0 +1,20 @@
+//#region src/business/formatFileSize/index.d.ts
+/**
+* 文件大小格式化
+*
+* @param bytes - 字节数
+* @param decimals - 小数位数，默认 2
+* @returns 格式化后的文件大小字符串
+*
+* @example
+* ```ts
+* import formatFileSize from '@tanwan/utils/formatFileSize'
+* formatFileSize(0)           // '0 B'
+* formatFileSize(1024)        // '1 KB'
+* formatFileSize(1536000)     // '1.46 MB'
+* formatFileSize(1073741824)  // '1 GB'
+* ```
+*/
+declare function formatFileSize(bytes: number, decimals?: number): string;
+//#endregion
+export { formatFileSize as default };

package/dist/formatFileSize.js

@@ -0,0 +1,33 @@
+//#region src/business/formatFileSize/index.ts
+/**
+* 文件大小格式化
+*
+* @param bytes - 字节数
+* @param decimals - 小数位数，默认 2
+* @returns 格式化后的文件大小字符串
+*
+* @example
+* ```ts
+* import formatFileSize from '@tanwan/utils/formatFileSize'
+* formatFileSize(0)           // '0 B'
+* formatFileSize(1024)        // '1 KB'
+* formatFileSize(1536000)     // '1.46 MB'
+* formatFileSize(1073741824)  // '1 GB'
+* ```
+*/
+function formatFileSize(bytes, decimals = 2) {
+	if (bytes === 0) return "0 B";
+	const units = [
+		"B",
+		"KB",
+		"MB",
+		"GB",
+		"TB",
+		"PB"
+	];
+	const k = 1024;
+	const i = Math.floor(Math.log(bytes) / Math.log(k));
+	return `${Number.parseFloat((bytes / k ** i).toFixed(decimals))} ${units[i]}`;
+}
+//#endregion
+export { formatFileSize as default };

package/dist/formatIdCard.cjs

@@ -0,0 +1,21 @@
+//#region src/business/formatIdCard/index.ts
+/**
+* 身份证号格式化 / 脱敏
+*
+* @param idCard - 18 位身份证号
+* @param mode - `'display'`（显示） | `'mask'`（脱敏，默认）
+* @returns 格式化后的身份证号
+*
+* @example
+* ```ts
+* import formatIdCard from '@tanwan/utils/formatIdCard'
+* formatIdCard('510123199001011234')             // '510123********1234'
+* formatIdCard('510123199001011234', 'display')  // '510123 19900101 1234'
+* ```
+*/
+function formatIdCard(idCard, mode = "mask") {
+	if (mode === "display") return idCard.replace(/(\d{6})(\d{8})(\d{4})/, "$1 $2 $3");
+	return idCard.replace(/(\d{6})\d{8}(\d{4})/, "$1********$2");
+}
+//#endregion
+module.exports = formatIdCard;

package/dist/formatIdCard.d.cts

@@ -0,0 +1,17 @@
+//#region src/business/formatIdCard/index.d.ts
+/**
+* 身份证号格式化 / 脱敏
+*
+* @param idCard - 18 位身份证号
+* @param mode - `'display'`（显示） | `'mask'`（脱敏，默认）
+* @returns 格式化后的身份证号
+*
+* @example
+* ```ts
+* import formatIdCard from '@tanwan/utils/formatIdCard'
+* formatIdCard('510123199001011234')             // '510123********1234'
+* formatIdCard('510123199001011234', 'display')  // '510123 19900101 1234'
+* ```
+*/
+declare function formatIdCard(idCard: string, mode?: "display" | "mask"): string;
+export = formatIdCard;

package/dist/formatIdCard.d.ts

@@ -0,0 +1,18 @@
+//#region src/business/formatIdCard/index.d.ts
+/**
+* 身份证号格式化 / 脱敏
+*
+* @param idCard - 18 位身份证号
+* @param mode - `'display'`（显示） | `'mask'`（脱敏，默认）
+* @returns 格式化后的身份证号
+*
+* @example
+* ```ts
+* import formatIdCard from '@tanwan/utils/formatIdCard'
+* formatIdCard('510123199001011234')             // '510123********1234'
+* formatIdCard('510123199001011234', 'display')  // '510123 19900101 1234'
+* ```
+*/
+declare function formatIdCard(idCard: string, mode?: "display" | "mask"): string;
+//#endregion
+export { formatIdCard as default };

package/dist/formatIdCard.js

@@ -0,0 +1,21 @@
+//#region src/business/formatIdCard/index.ts
+/**
+* 身份证号格式化 / 脱敏
+*
+* @param idCard - 18 位身份证号
+* @param mode - `'display'`（显示） | `'mask'`（脱敏，默认）
+* @returns 格式化后的身份证号
+*
+* @example
+* ```ts
+* import formatIdCard from '@tanwan/utils/formatIdCard'
+* formatIdCard('510123199001011234')             // '510123********1234'
+* formatIdCard('510123199001011234', 'display')  // '510123 19900101 1234'
+* ```
+*/
+function formatIdCard(idCard, mode = "mask") {
+	if (mode === "display") return idCard.replace(/(\d{6})(\d{8})(\d{4})/, "$1 $2 $3");
+	return idCard.replace(/(\d{6})\d{8}(\d{4})/, "$1********$2");
+}
+//#endregion
+export { formatIdCard as default };

package/dist/formatPhone.cjs

@@ -0,0 +1,21 @@
+//#region src/business/formatPhone/index.ts
+/**
+* 手机号格式化
+*
+* @param phone - 11 位手机号字符串
+* @param mode - `'display'`（显示：188-1234-5678，默认）| `'mask'`（脱敏：188****5678）
+* @returns 格式化后的手机号
+*
+* @example
+* ```ts
+* import formatPhone from '@tanwan/utils/formatPhone'
+* formatPhone('18812345678')              // '188-1234-5678'
+* formatPhone('18812345678', 'mask')      // '188****5678'
+* ```
+*/
+function formatPhone(phone, mode = "display") {
+	if (mode === "mask") return phone.replace(/(\d{3})\d{4}(\d{4})/, "$1****$2");
+	return phone.replace(/(\d{3})(\d{4})(\d{4})/, "$1-$2-$3");
+}
+//#endregion
+module.exports = formatPhone;

package/dist/formatPhone.d.cts

@@ -0,0 +1,17 @@
+//#region src/business/formatPhone/index.d.ts
+/**
+* 手机号格式化
+*
+* @param phone - 11 位手机号字符串
+* @param mode - `'display'`（显示：188-1234-5678，默认）| `'mask'`（脱敏：188****5678）
+* @returns 格式化后的手机号
+*
+* @example
+* ```ts
+* import formatPhone from '@tanwan/utils/formatPhone'
+* formatPhone('18812345678')              // '188-1234-5678'
+* formatPhone('18812345678', 'mask')      // '188****5678'
+* ```
+*/
+declare function formatPhone(phone: string, mode?: "display" | "mask"): string;
+export = formatPhone;