fs-realpath-native 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [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
+
+
+
+
+
+## [1.0.4](https://github.com/bluelovers/ws-iconv/compare/fs-realpath-native@1.0.3...fs-realpath-native@1.0.4) (2026-03-01)
+
+
+
+### 📚　Documentation
+
+* 为多个包添加全面的 JSDoc 文档和 README 更新 ([0d149e8](https://github.com/bluelovers/ws-iconv/commit/0d149e856aa9b274aca7fd7562776860c9d00473))
+
+
+### ♻️　Chores
+
+* Update jest config and add new files for testing ([f370583](https://github.com/bluelovers/ws-iconv/commit/f37058385c7bf24d3d0bc975c752f2f35cfe8356))
+
+
+
 ## [1.0.3](https://github.com/bluelovers/ws-iconv/compare/fs-realpath-native@1.0.2...fs-realpath-native@1.0.3) (2024-08-29)
 
 

package/README.md

@@ -1,12 +1,64 @@
-# README.md
+# fs-realpath-native
 
-    
+File system real path resolution with sync/async operations and error handling.
+檔案系統實體路徑處理，支援同步/異步操作和錯誤處理。
 
-## install
+## Features / 主要功能
+
+- Real path resolution / 實體路徑解析
+- Sync and async operations / 同步和異步操作
+- Error handling (ENOENT safe) / 錯誤處理（安全處理路徑不存在）
+- Encoding options support / 支援不同編碼選項
+- Compatible with Node.js fs module / 完全相容於 Node.js fs 模組
+
+## Install / 安裝
 
 ```bash
-yarn add fs-realpath
-yarn-tool add fs-realpath
-yt add fs-realpath
+yarn add fs-realpath-native
+yarn-tool add fs-realpath-native
+yt add fs-realpath-native
+pnpm add fs-realpath-native
+npm install fs-realpath-native
 ```
 
+## Quick Start / 快速開始
+
+```typescript
+import { 
+  fsRealpathNativeSync, 
+  fsRealpathNativeAsync,
+  tryFsRealpathNativeSync,
+  tryFsRealpathNativeAsync 
+} from 'fs-realpath-native';
+
+// Synchronous / 同步
+const realPath = fsRealpathNativeSync('./symlink-to-file');
+console.log(realPath);
+
+// Asynchronous / 異步
+const realPathAsync = await fsRealpathNativeAsync('./symlink-to-file');
+console.log(realPathAsync);
+
+// Safe version (returns original path if not exists) / 安全版本（路徑不存在時返回原路徑）
+const safePath = tryFsRealpathNativeSync('./maybe-not-exists');
+console.log(safePath);
+```
+
+## API
+
+### `fsRealpathNativeSync(path, options?)`
+Resolves the real path synchronously using native OS methods.
+使用原生作業系統方法同步解析實體路徑。
+
+### `fsRealpathNativeAsync(path, options?)`
+Resolves the real path asynchronously using native OS methods.
+使用原生作業系統方法異步解析實體路徑。
+
+### `tryFsRealpathNativeSync(path, options?)`
+Safely resolves the real path synchronously. Returns original path if not exists.
+安全地同步解析實體路徑。如果路徑不存在則返回原路徑。
+
+### `tryFsRealpathNativeAsync(path, options?)`
+Safely resolves the real path asynchronously. Returns original path if not exists.
+安全地異步解析實體路徑。如果路徑不存在則返回原路徑。
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fs-realpath-native",
-  "version": "1.0.3",
-  "description": "",
+  "version": "1.0.5",
+  "description": "File system real path resolution with sync/async operations and error handling / 檔案系統實體路徑處理，支援同步/異步操作和錯誤處理",
   "keywords": [
     "create-by-yarn-tool"
   ],
@@ -31,6 +31,7 @@
     "pretest": "echo pretest",
     "test": "jest --passWithNoTests",
     "test:jest": "jest --passWithNoTests",
+    "test:jest:coverage": "yarn run test:jest -- --coverage",
     "test:jest:snapshot": "yarn run test:jest -- -u",
     "test:mocha": "ynpx --quiet -p ts-node -p mocha mocha -- --require ts-node/register \"!(node_modules)/**/*.{test,spec}.{ts,tsx}\"",
     "test:snapshot": "yarn run test -- -u",
@@ -61,6 +62,5 @@
     "sort-package-json": "yarn-tool sort",
     "tsc:showConfig": "ynpx get-current-tsconfig -p"
   },
-  "packageManager": "yarn@1.22.19",
-  "gitHead": "43bcf89adcf481e321b509f7510de10206e8030a"
+  "gitHead": "6bcfe6a585ad7e5657a40a5b0727c6281b564b60"
 }

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAOA,sDAKC;AAQD,0DAeC;AAKD,4DAGC;AA3CD,2BAAkF;AAErE,QAAA,oBAAoB,GAAG,iBAAY,CAAC,MAAM,CAAC;AAKjD,KAAK,UAAU,qBAAqB,CAAC,IAAc,EACzD,OAA+C;IAG/C,OAAO,IAAA,4BAAoB,EAAC,IAAI,EAAE,OAAc,CAAC,CAAA;AAClD,CAAC;AAQD,SAAgB,uBAAuB,CAAC,IAAc,EAAE,OAA+C;IAEtG,IACA,CAAC;QACA,IAAI,GAAG,iBAAY,CAAC,MAAM,CAAC,IAAI,EAAE,OAAc,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAU,EACjB,CAAC;QACA,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAC3B,CAAC;YACA,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAED,OAAO,IAAW,CAAC;AACpB,CAAC;AAKM,KAAK,UAAU,wBAAwB,CAAC,IAAc,EAAE,OAA+C;IAE7G,OAAO,uBAAuB,CAAC,IAAI,EAAE,OAAc,CAAC,CAAA;AACrD,CAAC;AAED,kBAAe,uBAAuB,CAAA","sourcesContent":["import { BufferEncodingOption, EncodingOption, PathLike, realpathSync } from 'fs';\n\nexport const fsRealpathNativeSync = realpathSync.native;\n\nexport async function fsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string>;\nexport async function fsRealpathNativeAsync(path: PathLike, options: BufferEncodingOption): Promise<Buffer>;\nexport async function fsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string | Buffer>;\nexport async function fsRealpathNativeAsync(path: PathLike,\n\toptions?: BufferEncodingOption | EncodingOption\n): Promise<string | Buffer>\n{\n\treturn fsRealpathNativeSync(path, options as any)\n}\n\n/**\n * @see https://github.com/facebook/jest/blob/main/packages/jest-util/src/tryRealpath.ts\n */\nexport function tryFsRealpathNativeSync(path: PathLike, options?: EncodingOption): string;\nexport function tryFsRealpathNativeSync(path: PathLike, options: BufferEncodingOption): Buffer;\nexport function tryFsRealpathNativeSync(path: PathLike, options?: EncodingOption): string | Buffer;\nexport function tryFsRealpathNativeSync(path: PathLike, options?: BufferEncodingOption | EncodingOption): string | Buffer\n{\n\ttry\n\t{\n\t\tpath = realpathSync.native(path, options as any);\n\t}\n\tcatch (error: any)\n\t{\n\t\tif (error.code !== 'ENOENT')\n\t\t{\n\t\t\tthrow error;\n\t\t}\n\t}\n\n\treturn path as any;\n}\n\nexport async function tryFsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string>;\nexport async function tryFsRealpathNativeAsync(path: PathLike, options: BufferEncodingOption): Promise<Buffer>;\nexport async function tryFsRealpathNativeAsync(path: PathLike, options?: EncodingOption): Promise<string | Buffer>;\nexport async function tryFsRealpathNativeAsync(path: PathLike, options?: BufferEncodingOption | EncodingOption): Promise<string | Buffer>\n{\n\treturn tryFsRealpathNativeSync(path, options as any)\n}\n\nexport default tryFsRealpathNativeSync\n"]}