@minto-ai/tools 1.0.39 → 1.0.45

package/dist/array/chunk-array.d.ts

@@ -1,12 +1,11 @@
 /**
- * 将一个数组分割成多个指定大小的块。
- * 这个函数接受一个数组和一个指定的块大小，然后返回一个二维数组。
+ * 将一个数组分割成多个指定大小的块。这个函数接受一个数组和一个指定的块大小，然后返回一个二维数组。
  * 每个子数组包含原数组中的一部分元素，大小由 `chunkSize` 参数决定。
  * 如果数组的长度不是 `chunkSize` 的整数倍，最后一个块可能包含的元素少于 `chunkSize`。
  *
  * @param array  要分割的源数组。
  * @param chunkSize  每个块的大小。必须为正整数。默认值为 1。
- * @returns 返回一个二维数组，每个子数组包含原数组的一部分元素。
+ * @returns 返回一个二维数组，每个子数组是原数组的一部分元素。
  */
 declare function chunkArray<T>(array: T[], chunkSize?: number): T[][];
 export default chunkArray;

package/dist/browser/copy-text.d.ts

@@ -1,8 +1,7 @@
 /**
- * 复制文本到剪贴板的函数。
- * 如果复制成功，返回一个包含被复制文本的 Promise；如果失败，返回一个包含错误信息的 Promise。
+ * 复制文本到剪贴板。
  *
- * @param text  需要复制的文本内容。
+ * @param text  需要复制到剪贴板的文本。
  * @returns 返回一个 Promise 对象。成功时返回被复制的文本，失败时返回错误信息。
  */
 declare function copyText(text: string): Promise<string>;

package/dist/browser/is-android.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断当前设备是否为 Android 设备
- * 通过检测用户代理字符串中是否包含 "android" 关键字来判断。
+ * 判断当前环境是否为 Android 设备。
+ * 主要检测设备类型为 Android。
  *
- * @returns 如果是 Android 设备，返回 true；否则返回 false。
+ * @returns 如果是Android设备，返回true；否则返回false。
  */
 declare function isAndroid(): boolean;
 export default isAndroid;

package/dist/browser/is-ios.d.ts

@@ -1,5 +1,5 @@
 /**
- * 判断当前设备是否为iOS设备
+ * 判断当前环境是否为 iOS 设备。
  * 主要检测的设备类型包括 iPhone、iPad 和 iPod。
  *
  * @returns 如果是iOS设备，返回true；否则返回false。

package/dist/browser/is-mobile.d.ts

@@ -1,9 +1,8 @@
 /**
- * 判断当前设备是否为移动设备（手机或平板）。
- * 通过检测设备是否为 Android 或 iOS 设备来判断是否为移动设备。
- * 如果设备是 Android 或 iOS 设备，则认为是移动设备。
+ * 判断当前环境是否为移动设备。
+ * 主要检测设备类型为移动设备。
  *
- * @returns 如果是移动设备，返回 true；否则返回 false。
+ * @returns 如果是移动设备，返回true；否则返回false。
  */
 declare function isMobile(): boolean;
 export default isMobile;

package/dist/browser/is-pc.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断当前设备是否为桌面设备（PC）。
- * 如果当前设备不是移动设备（手机或平板），则认为是桌面设备。
+ * 判断当前环境是否为PC设备。
+ * 主要检测设备类型为PC设备。
  *
- * @returns 如果是桌面设备，返回 true；否则返回 false。
+ * @returns 如果是PC设备，返回true；否则返回false。
  */
 declare function isPc(): boolean;
 export default isPc;

package/dist/core/be-parsed-as-number.d.ts

@@ -2,7 +2,7 @@
  * 将输入值转换为数字类型。
  *
  * @param value 输入值。
- * @returns 转换后的数字值，如果无法解析则返回 `NaN`。
+ * @returns 输入值转换后的数字值，如果无法解析则返回 `NaN`。
  */
 declare function beParsedAsNumber(value: number | string): number;
 export default beParsedAsNumber;

package/dist/core/can-be-parsed-as-number.d.ts

@@ -1,8 +1,8 @@
 /**
- * 检查一个值是否可以被解析为有效的数字。
+ * 检查输入值是否可以被解析为有效的数字。
  *
- * @param value 需要检查的值
- * @returns 如果值可以被解析为数字，则返回 true；否则返回 false
+ * @param value 输入值。
+ * @returns 如果输入值可以被解析为一个有效的数字，则返回 `true`，否则返回 `false`。
  */
 declare function canBeParsedAsNumber(value: unknown): boolean;
 export default canBeParsedAsNumber;

package/dist/core/check-array-empty.d.ts

@@ -1,8 +1,8 @@
 /**
- * 检查数组是否为空
+ * 检查输入值是否是空数组。
  *
- * @param value 要检查的值。
- * @returns 如果 value 是一个数组并且长度为0返回 true，否则返回false
+ * @param value 输入值。
+ * @returns 如果输入值是一个空数组，则返回 `true`；否则返回 `false`。
  */
 declare function checkArrayEmpty(value: unknown): value is Array<unknown>;
 export default checkArrayEmpty;

package/dist/core/check-empty-not-zero.d.ts

@@ -1,8 +1,8 @@
 /**
- * 检查给定的值是否为空，但不包括数字 0。空值包括：空字符串、空数组、空对象、null 或 undefined。
+ * 检查输入值是否为空（''、null、undefined、[]、{}）,但是不能为0。
  *
- * @param value 要检查的值。
- * @returns 如果值是空的，且不是数字 0，则返回 true，否则返回 false。
+ * @param value 输入值。
+ * @returns 如果输入值是空（''、null、undefined、[]、{}），但不包括0，则返回 `true`；否则返回 `false`。
  */
 declare function checkEmptyNotZero(value: unknown): value is null | undefined | '' | [] | Record<string, never>;
 export default checkEmptyNotZero;

package/dist/core/check-empty.d.ts

@@ -1,9 +1,8 @@
 /**
- * 检查给定的值是否为空。
- * 空值包括：空字符串、空数组、空对象、null 或 undefined。
+ * 检查输入值是否为空（''、0、null、undefined、[]、{}）。
  *
- * @param value 要检查的值。
- * @returns 如果值是空的，则返回 true，否则返回 false。
+ * @param value 输入值。
+ * @returns 如果输入值是空的，则返回 true，否则返回 false。
  */
 declare function checkEmpty(value: unknown): value is null | undefined | '' | [] | Record<string, never> | 0;
 export default checkEmpty;

package/dist/core/check-object-empty.d.ts

@@ -1,8 +1,7 @@
 /**
- * 检查对象是否为空。
- * 一个空对象是指没有任何自身属性的对象。
+ * 检查输入值是否是空对象
  *
- * @param value 要检查的值。
+ * @param value 输入值。
  * @returns 如果值是一个空对象，则返回 true，否则返回 false。
  */
 declare function checkObjectEmpty(value: unknown): value is Record<string, never>;

package/dist/core/is-array.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断给定的值是否是一个数组。
+ * 判断输入值是否是一个数组。
  *
- * @param value 要检查的值。
- * @returns 如果 value 是一个数组，则返回 true，否则返回 false。
+ * @param value 输入值。
+ * @returns 如果输入值是一个数组，则返回 true，否则返回 false。
  */
 declare function isArray(value: unknown): value is Array<unknown>;
 export default isArray;

package/dist/core/is-null-or-undefined.d.ts

@@ -1,7 +1,7 @@
 /**
- * 检查一个值是否为 null 或 undefined。
- * @param value - 要检查的值。
- * @returns 如果值为 null 或 undefined，则返回 true；否则返回 false。
+ * 检查输入值是否为 null 或 undefined。
+ * @param value  输入值。
+ * @returns 如果输入值为 null 或 undefined，则返回 true；否则返回 false。
  */
 declare function isNullOrUndefined(value: unknown): value is null | undefined;
 export default isNullOrUndefined;

package/dist/core/is-number.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断给定的值是否是一个数字。
+ * 判断输入值是否是一个数字。
  *
- * @param value 要检查的值。
- * @returns  如果 value 是一个数字，则返回 true，否则返回 false。
+ * @param value 输入值。
+ * @returns  如果输入值是一个数字，则返回 true，否则返回 false。
  */
 declare function isNumber(value: unknown): value is number;
 export default isNumber;

package/dist/core/is-object.d.ts

@@ -1,8 +1,9 @@
 /**
- * 判断给定的值是否是一个对象。但对象的值包含 null 的情况，返回 false。
+ * 判断输入值是否是一个对象。
+ * 注意：此函数不将 null 视为对象，因此如果输入值是 null，将返回 false。
  *
- * @param value 要检查的值。
- * @returns 如果 value 是一个普通对象，则返回 true，否则返回 false。
+ * @param value 输入值。
+ * @returns 如果输入值是一个普通对象并且不等于 null ，则返回 true；否则返回 false。
  */
 declare function isObject(value: unknown): value is Record<PropertyKey, unknown>;
 export default isObject;

package/dist/core/is-string.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断给定的值是否是一个字符串。
+ * 判断输入值是否是一个字符串。
  *
- * @param value 要检查的值。
- * @returns 如果 value 是一个字符串，则返回 true，否则返回 false。
+ * @param value 输入值。
+ * @returns 如果输入值是一个字符串，则返回 true，否则返回 false。
  */
 declare function isString(value: unknown): value is string;
 export default isString;

package/dist/core/is-undefined.d.ts

@@ -1,8 +1,8 @@
 /**
- * 检查一个值是否为 undefined。
+ * 检查输入值是否为 undefined。
  *
- * @param value 需要检查的值。
- * @returns 如果值为 undefined，则返回 true；否则返回 false。
+ * @param value 输入值。
+ * @returns 如果输入值为 undefined，则返回 true；否则返回 false。
  */
 declare function isUndefined(value: unknown): value is undefined;
 export default isUndefined;

package/dist/file/batch-download-file.d.ts

@@ -1,8 +1,9 @@
 /**
- * 批量下载文件并打包为 ZIP
+ * 批量下载文件并打包为 ZIP。该函数接受一个文件列表，每个文件包含文件路径和可选的文件名，最终将所有文件打包为一个 ZIP 文件并触发下载。
  *
- * @param fileList 文件列表，包含文件路径和文件名
- * @param zipName 打包后的 ZIP 文件名
+ * @param fileList 文件列表，每个文件包含文件路径和可选的文件名。如果未提供文件名，将自动从文件路径中提取。
+ * @param zipName 打包后的 ZIP 文件名。如果文件名不以 `.zip` 结尾，将自动添加 `.zip` 后缀。
+ * @returns  返回一个 Promise，在文件打包和下载完成后。
  */
 declare function batchDownloadFile(fileList: Array<{
     filePath: string;

package/dist/file/extends/enum.d.ts

@@ -22,6 +22,8 @@ declare const FileSuffixEnum: {
     readonly WAV: "wav";
     readonly TXT: "txt";
     readonly HTML: "html";
+    readonly ZIP: "zip";
+    readonly RAR: "rar";
 };
 /**
  * 图片后缀类型枚举
@@ -65,5 +67,13 @@ declare const DocumentFileSuffixEnum: {
  */
 declare const MusicFileSuffixEnum: {
     readonly MP3: "mp3";
+    readonly WAV: "wav";
+};
+/**
+ * 压缩文件后缀类型枚举
+ */
+declare const CompressFileSuffixEnum: {
+    readonly ZIP: "zip";
+    readonly RAR: "rar";
 };
-export { DocumentFileSuffixEnum, FileSuffixEnum, ImageFileSuffixEnum, MusicFileSuffixEnum, PptFileSuffixEnum, VideoFileSuffixEnum, };
+export { CompressFileSuffixEnum, DocumentFileSuffixEnum, FileSuffixEnum, ImageFileSuffixEnum, MusicFileSuffixEnum, PptFileSuffixEnum, VideoFileSuffixEnum, };

package/dist/file/get-file-icon.d.ts

@@ -1,8 +1,8 @@
 /**
- * 根据文件路径获取对应的图标
+ * 根据文件后缀获取对应的图标。
  *
- * @param filePath 文件路径
- * @returns 图标路径
+ * @param filePath 文件路径。
+ * @returns 对应文件类型的图标。
  */
 declare function getFileIcon(filePath: string): string;
 export default getFileIcon;

package/dist/file/get-file-name.d.ts

@@ -1,8 +1,8 @@
 /**
- * 获取完整的文件名（包含后缀）
+ * 从文件路径中提取完整的文件名（包含后缀）。
  *
- * @param  filePath 文件路径
- * @returns  完整的文件名
+ * @param  filePath 文件路径。
+ * @returns  文件名（包含后缀）。
  */
 declare function getFileName(filePath: string): string;
 export default getFileName;

package/dist/file/get-file-suffix-icon.d.ts

@@ -1,9 +1,9 @@
 import { FileSuffix } from './types';
 /**
- * 根据文件后缀获取对应的图标
+ * 根据文件后缀获取对应的图标。
  *
- * @param fileSuffix 文件后缀（需为 FileSuffixEnum 中的有效值）
- * @returns 对应的图标路径，若未匹配则返回默认图标
+ * @param fileSuffix 文件后缀。
+ * @returns 对应的图标路径，若未匹配则返回默认图标。
  */
 declare function getFileSuffixIcon(fileSuffix: FileSuffix): string;
 export default getFileSuffixIcon;

package/dist/file/get-file-suffix.d.ts

@@ -1,9 +1,9 @@
 import { FileSuffix } from './types';
 /**
- * 获取文件后缀
+ * 从文件路径中提取文件后缀。
  *
- * @param  filePath 文件路径或文件名
- * @returns 文件后缀
+ * @param  filePath 文件路径。
+ * @returns 文件后缀，以小写形式返回。如果文件没有后缀或路径无效，返回空字符串。
  */
 declare function getFileSuffix(filePath: string): FileSuffix;
 export default getFileSuffix;

package/dist/file/get-file-title.d.ts

@@ -1,8 +1,8 @@
 /**
- * 获取文件名（不包含后缀）
+ * 从文件路径中提取文件名（不包含后缀）。
  *
- * @param  filePath 文件路径
- * @returns  文件名（不包含后缀）
+ * @param  filePath 文件路径。
+ * @returns  文件名（不包含后缀）。
  */
 declare function getFileTitle(filePath: string): string;
 export default getFileTitle;

package/dist/file/index.d.ts

@@ -1,4 +1,4 @@
-import { DocumentFileSuffix, FileSuffix, ImageFileSuffix, MusicFileSuffix, PptFileSuffix, VideoFileSuffix } from './types';
+import { CompressFileSuffix, DocumentFileSuffix, FileSuffix, ImageFileSuffix, MusicFileSuffix, PptFileSuffix, VideoFileSuffix } from './types';
 import { default as batchDownloadFile } from './batch-download-file';
 import { FileSuffixEnum, ImageFileSuffixEnum } from './extends/enum';
 import { default as getFileIcon } from './get-file-icon';
@@ -6,6 +6,7 @@ import { default as getFileName } from './get-file-name';
 import { default as getFileSuffix } from './get-file-suffix';
 import { default as getFileSuffixIcon } from './get-file-suffix-icon';
 import { default as getFileTitle } from './get-file-title';
+import { default as isCompressFilePath } from './is-compress-file-path';
 import { default as isDocumentFilePath } from './is-document-file-path';
 import { default as isFilePath } from './is-file-path';
 import { default as isImageFilePath } from './is-image-file-path';
@@ -13,5 +14,5 @@ import { default as isMusicFilePath } from './is-music-file-path';
 import { default as isPptFilePath } from './is-ppt-file-path';
 import { default as isVideoFilePath } from './is-video-file-path';
 import { default as singleDownloadFile } from './single-download-file';
-export type { DocumentFileSuffix, FileSuffix, ImageFileSuffix, MusicFileSuffix, PptFileSuffix, VideoFileSuffix, };
-export { batchDownloadFile, FileSuffixEnum, getFileIcon, getFileName, getFileSuffix, getFileSuffixIcon, getFileTitle, ImageFileSuffixEnum, isDocumentFilePath, isFilePath, isImageFilePath, isMusicFilePath, isPptFilePath, isVideoFilePath, singleDownloadFile, };
+export type { CompressFileSuffix, DocumentFileSuffix, FileSuffix, ImageFileSuffix, MusicFileSuffix, PptFileSuffix, VideoFileSuffix, };
+export { batchDownloadFile, FileSuffixEnum, getFileIcon, getFileName, getFileSuffix, getFileSuffixIcon, getFileTitle, ImageFileSuffixEnum, isCompressFilePath, isDocumentFilePath, isFilePath, isImageFilePath, isMusicFilePath, isPptFilePath, isVideoFilePath, singleDownloadFile, };

package/dist/file/is-compress-file-path.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 判断是否是有效的压缩文件路径（包含 rar、zip ）。
+ *
+ * @param filePath 文件路径。
+ * @returns  是否是有效的压缩文件路径。
+ */
+declare function isCompressFilePath(filePath: string): boolean;
+export default isCompressFilePath;

package/dist/file/is-document-file-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断是否是有效的文档文件路径（包含doc、docx、pdf、txt、xls、xlsx）
+ * 判断是否是有效的文档文件路径（包含doc、docx、pdf、txt、xls、xlsx）。
  *
- * @param filePath 文件路径
- * @returns  是否是有效的文档文件路径
+ * @param filePath 文件路径。
+ * @returns  是否是有效的文档文件路径。
  */
 declare function isDocumentFilePath(filePath: string): boolean;
 export default isDocumentFilePath;

package/dist/file/is-file-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断是否是有效的文件路径
+ * 判断是否是有效的文件路径（包含doc、docx、pdf、ppt、pptx、xls、xlsx、jpg、jpeg、png、webp、gif、mp4、avi、flv、mkv、mp3、mav、txt、html）。
  *
- * @param filePath 文件路径
- * @returns 是否是有效的文件路径
+ * @param filePath 文件路径。
+ * @returns 是否是有效的文件路径（空后缀文件不属于有效文件路径）。
  */
 declare function isFilePath(filePath: string): boolean;
 export default isFilePath;

package/dist/file/is-image-file-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断是否是有效的图片文件路径（包含jpg、jpeg、png、webp）
+ * 判断是否是有效的图片文件路径（包含jpg、jpeg、png、webp、gif）。
  *
- * @param filePath 文件路径
- * @returns 是否是有效的图片文件路径
+ * @param filePath 文件路径。
+ * @returns 是否是有效的图片文件路径。
  */
 declare function isImageFilePath(filePath: string): boolean;
 export default isImageFilePath;

package/dist/file/is-music-file-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断是否是有效的音乐文件路径（包含mp3）
+ * 判断是否是有效的音乐文件路径（包含mp3）。
  *
- * @param filePath 文件路径
- * @returns  是否是有效的音乐文件路径
+ * @param filePath 文件路径。
+ * @returns  是否是有效的音乐文件路径。
  */
 declare function isMusicFilePath(filePath: string): boolean;
 export default isMusicFilePath;

package/dist/file/is-ppt-file-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断是否是有效的ppt文件路径（包含ppt、pptx）
+ * 判断是否是有效的ppt文件路径（包含ppt、pptx）。
  *
- * @param  filePath 文件路径
- * @returns 是否是有效的ppt文件路径
+ * @param  filePath 文件路径。
+ * @returns 是否是有效的ppt文件路径。
  */
 declare function isPptFilePath(filePath: string): boolean;
 export default isPptFilePath;

package/dist/file/is-video-file-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * 判断是否是有效的视频文件路径（包含mp4、avi、flv、mkv）
+ * 判断是否是有效的视频文件路径（包含mp4、avi、flv、mkv）。
  *
- * @param filePath 文件路径
- * @returns 是否是有效的视频文件路径
+ * @param filePath 文件路径。
+ * @returns 是否是有效的视频文件路径。
  */
 declare function isVideoFilePath(filePath: string): boolean;
 export default isVideoFilePath;

package/dist/file/single-download-file.d.ts

@@ -1,8 +1,9 @@
 /**
- * 下载单个文件
+ * 下载单个文件。该函数通过指定的文件路径下载文件，并允许自定义下载文件的名称。
  *
- * @param filePath 文件路径（必须）
- * @param fileName 下载时保存的文件名（可选）
+ * @param filePath 文件路径。
+ * @param fileName 下载时保存的文件名（可选）。如果未提供，将自动从 第一个参数`filePath` 提取文件名。
+ * @returns 返回一个 Promise，在文件下载完成后。
  */
 declare function singleDownloadFile(filePath: string, fileName?: string): Promise<void>;
 export default singleDownloadFile;

package/dist/file/types/index.d.ts

@@ -1,8 +1,9 @@
-import { DocumentFileSuffixEnum, FileSuffixEnum, ImageFileSuffixEnum, MusicFileSuffixEnum, PptFileSuffixEnum, VideoFileSuffixEnum } from '../extends/enum';
+import { CompressFileSuffixEnum, DocumentFileSuffixEnum, FileSuffixEnum, ImageFileSuffixEnum, MusicFileSuffixEnum, PptFileSuffixEnum, VideoFileSuffixEnum } from '../extends/enum';
 type FileSuffix = (typeof FileSuffixEnum)[keyof typeof FileSuffixEnum];
 type ImageFileSuffix = (typeof ImageFileSuffixEnum)[keyof typeof ImageFileSuffixEnum];
 type VideoFileSuffix = (typeof VideoFileSuffixEnum)[keyof typeof VideoFileSuffixEnum];
 type PptFileSuffix = (typeof PptFileSuffixEnum)[keyof typeof PptFileSuffixEnum];
 type DocumentFileSuffix = (typeof DocumentFileSuffixEnum)[keyof typeof DocumentFileSuffixEnum];
 type MusicFileSuffix = (typeof MusicFileSuffixEnum)[keyof typeof MusicFileSuffixEnum];
-export type { DocumentFileSuffix, FileSuffix, ImageFileSuffix, MusicFileSuffix, PptFileSuffix, VideoFileSuffix, };
+type CompressFileSuffix = (typeof CompressFileSuffixEnum)[keyof typeof CompressFileSuffixEnum];
+export type { CompressFileSuffix, DocumentFileSuffix, FileSuffix, ImageFileSuffix, MusicFileSuffix, PptFileSuffix, VideoFileSuffix, };