fs-realpath-native 1.0.5 → 1.0.6

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.6](https://github.com/bluelovers/ws-iconv/compare/fs-realpath-native@1.0.5...fs-realpath-native@1.0.6) (2026-03-02)
+
+
+
+### 📚　Documentation
+
+* 為檔案系統相關套件新增雙語 JSDoc 註解與型別標註 ([83f3845](https://github.com/bluelovers/ws-iconv/commit/83f38456ccc0f5eca4f2a6505bee4caf7e634ba6))
+
+
+
 ## [1.0.5](https://github.com/bluelovers/ws-iconv/compare/fs-realpath-native@1.0.4...fs-realpath-native@1.0.5) (2026-03-01)
 
 **Note:** Version bump only for package fs-realpath-native

package/index.d.ts

@@ -1,15 +1,106 @@
+/**
+ * fs-realpath-native - 檔案系統實體路徑處理
+ *
+ * 這個模組提供了檔案系統實體路徑處理的功能，包括同步和異步操作，以及錯誤處理。
+ *
+ * @module fs-realpath-native
+ * @author bluelovers
+ */
 import { BufferEncodingOption, EncodingOption, PathLike, realpathSync } from 'fs';
+/** 同步解析實體路徑函數 */
 export declare const fsRealpathNativeSync: typeof realpathSync.native;
+/**
+ * 異步解析實體路徑
+ *
+ * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {EncodingOption} [options] 編碼選項
+ * @returns {Promise<string>} Promise，解析為字串
+ */
 export declare function fsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string>;
+/**
+ * 異步解析實體路徑
+ *
+ * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {BufferEncodingOption} options 編碼選項
+ * @returns {Promise<Buffer>} Promise，解析為緩衝區
+ */
 export declare function fsRealpathNativeAsync(path: PathLike, options: BufferEncodingOption): Promise<Buffer>;
+/**
+ * 異步解析實體路徑
+ *
+ * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {EncodingOption} [options] 編碼選項
+ * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區
+ */
 export declare function fsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string | Buffer>;
 /**
+ * 嘗試解析實體路徑（同步）
+ *
+ * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {EncodingOption} [options] 編碼選項
+ * @returns {string} 解析後的路徑或原路徑
  * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts
  */
 export declare function tryFsRealpathNativeSync(path: PathLike, options?: EncodingOption): string;
+/**
+ * 嘗試解析實體路徑（同步）
+ *
+ * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {BufferEncodingOption} options 編碼選項
+ * @returns {Buffer} 解析後的路徑或原路徑
+ * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts
+ */
 export declare function tryFsRealpathNativeSync(path: PathLike, options: BufferEncodingOption): Buffer;
+/**
+ * 嘗試解析實體路徑（同步）
+ *
+ * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {EncodingOption} [options] 編碼選項
+ * @returns {string | Buffer} 解析後的路徑或原路徑
+ * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts
+ */
 export declare function tryFsRealpathNativeSync(path: PathLike, options?: EncodingOption): string | Buffer;
+/**
+ * 嘗試解析實體路徑（異步）
+ *
+ * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {EncodingOption} [options] 編碼選項
+ * @returns {Promise<string>} Promise，解析為字串
+ */
 export declare function tryFsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string>;
+/**
+ * 嘗試解析實體路徑（異步）
+ *
+ * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {BufferEncodingOption} options 編碼選項
+ * @returns {Promise<Buffer>} Promise，解析為緩衝區
+ */
 export declare function tryFsRealpathNativeAsync(path: PathLike, options: BufferEncodingOption): Promise<Buffer>;
+/**
+ * 嘗試解析實體路徑（異步）
+ *
+ * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {EncodingOption} [options] 編碼選項
+ * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區
+ */
 export declare function tryFsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string | Buffer>;
+/** 預設導出 - 嘗試解析實體路徑（同步）函數 */
 export default tryFsRealpathNativeSync;

package/index.js

@@ -1,27 +1,70 @@
 "use strict";
+/**
+ * fs-realpath-native - 檔案系統實體路徑處理
+ *
+ * 這個模組提供了檔案系統實體路徑處理的功能，包括同步和異步操作，以及錯誤處理。
+ *
+ * @module fs-realpath-native
+ * @author bluelovers
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fsRealpathNativeSync = void 0;
 exports.fsRealpathNativeAsync = fsRealpathNativeAsync;
 exports.tryFsRealpathNativeSync = tryFsRealpathNativeSync;
 exports.tryFsRealpathNativeAsync = tryFsRealpathNativeAsync;
 const fs_1 = require("fs");
+/** 同步解析實體路徑函數 */
 exports.fsRealpathNativeSync = fs_1.realpathSync.native;
+/**
+ * 異步解析實體路徑
+ *
+ * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {BufferEncodingOption | EncodingOption} [options] 編碼選項
+ * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區
+ */
 async function fsRealpathNativeAsync(path, options) {
+    // 使用同步函數來實現異步功能
     return (0, exports.fsRealpathNativeSync)(path, options);
 }
+/**
+ * 嘗試解析實體路徑（同步）
+ *
+ * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {BufferEncodingOption | EncodingOption} [options] 編碼選項
+ * @returns {string | Buffer} 解析後的路徑或原路徑
+ * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts
+ */
 function tryFsRealpathNativeSync(path, options) {
     try {
+        // 嘗試解析實體路徑
         path = fs_1.realpathSync.native(path, options);
     }
     catch (error) {
+        // 如果錯誤不是因為路徑不存在，則重新拋出錯誤
         if (error.code !== 'ENOENT') {
             throw error;
         }
     }
+    // 返回解析後的路徑或原路徑
     return path;
 }
+/**
+ * 嘗試解析實體路徑（異步）
+ *
+ * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。
+ *
+ * @param {PathLike} path 要解析的路徑
+ * @param {BufferEncodingOption | EncodingOption} [options] 編碼選項
+ * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區
+ */
 async function tryFsRealpathNativeAsync(path, options) {
+    // 使用同步函數來實現異步功能
     return tryFsRealpathNativeSync(path, options);
 }
+/** 預設導出 - 嘗試解析實體路徑（同步）函數 */
 exports.default = tryFsRealpathNativeSync;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AA8CH,sDAMC;AA6CD,0DAkBC;AAyCD,4DAIC;AA9JD,2BAAkF;AAElF,iBAAiB;AACJ,QAAA,oBAAoB,GAAG,iBAAY,CAAC,MAAM,CAAC;AAgCxD;;;;;;;;GAQG;AACI,KAAK,UAAU,qBAAqB,CAAC,IAAc,EACzD,OAA+C;IAG/C,gBAAgB;IAChB,OAAO,IAAA,4BAAoB,EAAC,IAAI,EAAE,OAAc,CAAC,CAAA;AAClD,CAAC;AAmCD;;;;;;;;;GASG;AACH,SAAgB,uBAAuB,CAAC,IAAc,EAAE,OAA+C;IAEtG,IACA,CAAC;QACA,WAAW;QACX,IAAI,GAAG,iBAAY,CAAC,MAAM,CAAC,IAAI,EAAE,OAAc,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAU,EACjB,CAAC;QACA,wBAAwB;QACxB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAC3B,CAAC;YACA,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAED,eAAe;IACf,OAAO,IAAW,CAAC;AACpB,CAAC;AAgCD;;;;;;;;GAQG;AACI,KAAK,UAAU,wBAAwB,CAAC,IAAc,EAAE,OAA+C;IAE7G,gBAAgB;IAChB,OAAO,uBAAuB,CAAC,IAAI,EAAE,OAAc,CAAC,CAAA;AACrD,CAAC;AAED,4BAA4B;AAC5B,kBAAe,uBAAuB,CAAA","sourcesContent":["/**\n * fs-realpath-native - 檔案系統實體路徑處理\n * \n * 這個模組提供了檔案系統實體路徑處理的功能，包括同步和異步操作，以及錯誤處理。\n * \n * @module fs-realpath-native\n * @author bluelovers\n */\n\nimport { BufferEncodingOption, EncodingOption, PathLike, realpathSync } from 'fs';\n\n/** 同步解析實體路徑函數 */\nexport const fsRealpathNativeSync = realpathSync.native;\n\n/**\n * 異步解析實體路徑\n * \n * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {EncodingOption} [options] 編碼選項\n * @returns {Promise<string>} Promise，解析為字串\n */\nexport async function fsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string>;\n/**\n * 異步解析實體路徑\n * \n * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {BufferEncodingOption} options 編碼選項\n * @returns {Promise<Buffer>} Promise，解析為緩衝區\n */\nexport async function fsRealpathNativeAsync(path: PathLike, options: BufferEncodingOption): Promise<Buffer>;\n/**\n * 異步解析實體路徑\n * \n * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {EncodingOption} [options] 編碼選項\n * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區\n */\nexport async function fsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string | Buffer>;\n/**\n * 異步解析實體路徑\n * \n * 這個函數會異步解析指定路徑的實體路徑，支援不同的編碼選項。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {BufferEncodingOption | EncodingOption} [options] 編碼選項\n * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區\n */\nexport async function fsRealpathNativeAsync(path: PathLike,\n\toptions?: BufferEncodingOption | EncodingOption\n): Promise<string | Buffer>\n{\n\t// 使用同步函數來實現異步功能\n\treturn fsRealpathNativeSync(path, options as any)\n}\n\n/**\n * 嘗試解析實體路徑（同步）\n * \n * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {EncodingOption} [options] 編碼選項\n * @returns {string} 解析後的路徑或原路徑\n * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts\n */\nexport function tryFsRealpathNativeSync(path: PathLike, options?: EncodingOption): string;\n/**\n * 嘗試解析實體路徑（同步）\n * \n * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {BufferEncodingOption} options 編碼選項\n * @returns {Buffer} 解析後的路徑或原路徑\n * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts\n */\nexport function tryFsRealpathNativeSync(path: PathLike, options: BufferEncodingOption): Buffer;\n/**\n * 嘗試解析實體路徑（同步）\n * \n * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {EncodingOption} [options] 編碼選項\n * @returns {string | Buffer} 解析後的路徑或原路徑\n * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts\n */\nexport function tryFsRealpathNativeSync(path: PathLike, options?: EncodingOption): string | Buffer;\n/**\n * 嘗試解析實體路徑（同步）\n * \n * 這個函數會嘗試解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {BufferEncodingOption | EncodingOption} [options] 編碼選項\n * @returns {string | Buffer} 解析後的路徑或原路徑\n * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts\n */\nexport function tryFsRealpathNativeSync(path: PathLike, options?: BufferEncodingOption | EncodingOption): string | Buffer\n{\n\ttry\n\t{\n\t\t// 嘗試解析實體路徑\n\t\tpath = realpathSync.native(path, options as any);\n\t}\n\tcatch (error: any)\n\t{\n\t\t// 如果錯誤不是因為路徑不存在，則重新拋出錯誤\n\t\tif (error.code !== 'ENOENT')\n\t\t{\n\t\t\tthrow error;\n\t\t}\n\t}\n\n\t// 返回解析後的路徑或原路徑\n\treturn path as any;\n}\n\n/**\n * 嘗試解析實體路徑（異步）\n * \n * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {EncodingOption} [options] 編碼選項\n * @returns {Promise<string>} Promise，解析為字串\n */\nexport async function tryFsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string>;\n/**\n * 嘗試解析實體路徑（異步）\n * \n * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {BufferEncodingOption} options 編碼選項\n * @returns {Promise<Buffer>} Promise，解析為緩衝區\n */\nexport async function tryFsRealpathNativeAsync(path: PathLike, options: BufferEncodingOption): Promise<Buffer>;\n/**\n * 嘗試解析實體路徑（異步）\n * \n * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {EncodingOption} [options] 編碼選項\n * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區\n */\nexport async function tryFsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string | Buffer>;\n/**\n * 嘗試解析實體路徑（異步）\n * \n * 這個函數會嘗試異步解析指定路徑的實體路徑，如果路徑不存在則返回原路徑，不拋出錯誤。\n * \n * @param {PathLike} path 要解析的路徑\n * @param {BufferEncodingOption | EncodingOption} [options] 編碼選項\n * @returns {Promise<string | Buffer>} Promise，解析為字串或緩衝區\n */\nexport async function tryFsRealpathNativeAsync(path: PathLike, options?: BufferEncodingOption | EncodingOption): Promise<string | Buffer>\n{\n\t// 使用同步函數來實現異步功能\n\treturn tryFsRealpathNativeSync(path, options as any)\n}\n\n/** 預設導出 - 嘗試解析實體路徑（同步）函數 */\nexport default tryFsRealpathNativeSync\n\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fs-realpath-native",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "File system real path resolution with sync/async operations and error handling / 檔案系統實體路徑處理，支援同步/異步操作和錯誤處理",
   "keywords": [
     "create-by-yarn-tool"
@@ -62,5 +62,5 @@
     "sort-package-json": "yarn-tool sort",
     "tsc:showConfig": "ynpx get-current-tsconfig -p"
   },
-  "gitHead": "6bcfe6a585ad7e5657a40a5b0727c6281b564b60"
+  "gitHead": "6c690c4123ff9db0f807fbc9a05f509a832aee69"
 }