cache-path

cache-path

return a cache directory, like find-cache-dir do

回傳一個快取 (Cache) 目錄路徑，用法與 find-cache-dir 相同，差異在於本套件在任何環境下都能回傳路徑。

特色 (Features)

1. 在任何環境下都能回傳路徑 find-cache-dir 在非模組/專案目錄下執行時會回傳失敗，本套件仍會回傳可用的路徑。
2. 可自訂尋找快取路徑的順序 (Order) 透過 fnOrder 調整各種快取來源的嘗試順序。
3. 同步 (Sync) 與非同步 (Async) API 皆齊備 getCachePath / getCacheRoot 都有對應的 *Async 版本。
4. 支援名稱正規化 (Normalize)、雜湊 (Hash) 與隨機目錄 (Random Directory)。
5. 內建多種快取來源：node_modules/.cache、Yarn 快取、npm 快取、作業系統暫存目錄。

安裝 (Installation)

npm install cache-path

使用方式 (Usage)

API 型別定義

getCachePath 也有非同步版本 getCachePathAsync。

import { normalizeName, getCachePath } from 'cache-path';

console.log(normalizeName('@node-novel/sort'));
// => _node_novel_sort
console.log(normalizeName('@node-novel/sort', true));
// => 7bc015f2

// 在模組/專案目錄下執行時
console.log(getCachePath());
// => D:\Users\Documents\The Project\nodejs-yarn\ws-segment\packages\cache-path\node_modules\.cache
console.log(getCachePath('@node-novel/sort'));
// => D:\Users\Documents\The Project\nodejs-yarn\ws-segment\packages\cache-path\node_modules\.cache\_node_novel_sort

// 其他環境（例如系統暫存目錄）
console.log(getCachePath());
// => T:\cache\npm-cache\.cache
console.log(getCachePath('@node-novel/sort'));
// => T:\cache\npm-cache\.cache\_node_novel_sort

API 文件 (API Documentation)

各函式的完整參數與回傳值請參閱 index.ts 與 lib/ 原始碼中的 JSDoc。

設定 (Configuration)

getCachePath / getCacheRoot 接受 IOptions（定義於 lib/types.ts），亦可直接傳入字串作為 cwd。

相關文件

• 路徑工具模組 — § 5. packages/cache-path