@ybgnb/utils 0.1.8 → 0.1.9

package/dist/node.d.ts

@@ -1,2 +1,153 @@
-export * from './node/index.js';
-export {};
+/**
+ * 获取环境变量
+ */
+declare function getEnv(): {
+    [p: string]: string;
+};
+
+/**
+ * 判断路径是否是文件
+ */
+declare function isFile(filePath: string): Promise<boolean>;
+/**
+ * 判断文件是否存在
+ */
+declare function existsFile(file: string, mode?: number): Promise<boolean>;
+/**
+ * 确保目录存在
+ */
+declare function ensureDirSync(dirPath: string): Promise<void>;
+/**
+ * 确保目录存在
+ */
+declare function ensureDir(dirPath: string): Promise<void>;
+/**
+ * 判断错误是否为文件不存在
+ */
+declare function isFileNotFoundError(error: unknown): boolean;
+
+/**
+ * 删除指定目录下的所有文件和子目录（保留指定目录）
+ * @param dir 目标目录路径
+ * @return 成功删除的文件或目录路径数组
+ */
+declare function emptyDirectory(dir: string): Promise<string[]>;
+/**
+ * 删除文件（不删除目录）
+ * @param paths 文件路径列表
+ * @returns 成功删除的文件路径数组
+ */
+declare function deleteFiles(paths: string[]): Promise<string[]>;
+
+/**
+ * 下载文件
+ */
+declare function downloadFile(url: string, filePath: string): Promise<void>;
+
+/**
+ * 查找目录下符合条件的文件路径（不遍历子目录）
+ * @param dir 目标目录路径
+ * @param prefix 文件名前缀（需全字匹配）
+ * @param suffix 文件名后缀（需全字匹配，如 ".txt"）
+ * @return 符合条件的文件完整路径的数组
+ */
+declare function findFilesByPrefixAndSuffix(dir: string, prefix?: string, suffix?: string): Promise<string[]>;
+/**
+ * 查找文件（包含子目录）
+ * @param dir     目录
+ * @param target  查找目标名称或者过滤函数
+ */
+declare function findFiles(dir: string, target: string | ((fileName: string, fullPath?: string) => boolean)): Promise<string[]>;
+
+/**
+ * 读取 JSON 文件
+ */
+declare function readJSONFile<T>(filePath: string): Promise<T>;
+/**
+ * 将数据原子写入 JSON 文件（先写临时文件再替换）
+ */
+declare function writeJSONFile<T>(file: string, data: T): Promise<void>;
+/**
+ * 读取 JSON 文件，修改后写回（原子操作）
+ */
+declare function updateJSON<T>(file: string, updater: (oldData: T) => T): Promise<T>;
+/**
+ * 从文件读取 JSON，若文件不存在则调用 initData 初始化并写入
+ *
+ * @param file 文件绝对路径或相对路径
+ * @param initData 返回要写入的数据的异步函数
+ * @returns 解析后的数据
+ */
+declare function readOrInitJSON<T>(file: string, initData: () => Promise<T>): Promise<T>;
+
+/**
+ * 将 KB 文件大小格式化为字符串
+ * @param sizeKB 文件大小（单位：KB）
+ * @param invalidText 输入无效时返回文本
+ */
+declare function formatFileSizeFromKB(sizeKB: number, invalidText?: string): string;
+/**
+ * 获取目录总大小（字节），递归统计所有子文件
+ * 符号链接：只计算链接文件本身的大小，不跟随指向目录
+ * 权限错误：跳过该文件/目录，大小计为 0
+ * @param dir 目录路径
+ * @returns 总字节数
+ */
+declare function getDirSize(dir: string): Promise<number>;
+/**
+ * 获取文件/文件夹大小
+ * @param filePath 文件/文件夹路径
+ */
+declare function getFileSizeKB(filePath: string): Promise<number>;
+
+/**
+ * 命令执行的选项
+ */
+interface ExecOptions {
+    /**
+     * 判断结果码是否成功
+     * @param number 结果码
+     */
+    codeIsSuccess?: (number: number) => boolean;
+    /**
+     * 终止信号
+     */
+    signal?: AbortSignal;
+}
+/**
+ * 执行 windows 的命令
+ * @param cmd     命令
+ * @param options 执行选项
+ */
+declare function execWinCmd(cmd: string, options?: ExecOptions): Promise<string>;
+
+/**
+ * 文件拷贝工具，支持文件或文件夹
+ */
+declare function copyFile(source: string, destination: string, signal?: AbortSignal): Promise<void>;
+
+/**
+ * 打开资源管理器并定位到目录或者文件
+ * @param fileOrDir 定位的目录或文件
+ */
+declare function showInExplorer(fileOrDir: string): Promise<void>;
+
+/**
+ * 打开注册表
+ * @param path 显示的路径
+ */
+declare function openRegedit(path: string): Promise<string>;
+/**
+ * 导出注册表
+ * @param regPath 注册表路径
+ * @param filePath 导出的文件路径
+ */
+declare function exportRegedit(regPath: string, filePath: string): Promise<void>;
+/**
+ * 导入注册表
+ * @param regPath 注册表路径
+ * @param filePath 导入的文件路径
+ */
+declare function importRegedit(regPath: string, filePath: string): Promise<void>;
+
+export { copyFile, deleteFiles, downloadFile, emptyDirectory, ensureDir, ensureDirSync, execWinCmd, existsFile, exportRegedit, findFiles, findFilesByPrefixAndSuffix, formatFileSizeFromKB, getDirSize, getEnv, getFileSizeKB, importRegedit, isFile, isFileNotFoundError, openRegedit, readJSONFile, readOrInitJSON, showInExplorer, updateJSON, writeJSONFile };