Global

Methods

(async) getDisksInfo(optopt) → {Promise}

Description:
  • 取得各磁碟容量資訊,Windows以fs.statfs逐一查詢A:至Z:磁碟代號(需Node.js>=18.15.0),其他平台以df -kP取得,皆不依賴wmic

    Windows只列出可查得容量之磁碟代號,無媒體之光碟機等會略過;statfs無磁碟類型資訊,故卸除式、網路磁碟等可查得者亦會列出。 容量為0之偽檔案系統一律略過。同一磁碟代號或df同時只保留一個進行中請求,同時之呼叫共用其結果,逾時未結束者後續呼叫直接略過不重發;各呼叫者依自身逾時等待,df另依逾時值分開以免被較短逾時之發起者一併中止,但任一df逾期超過1秒仍未結束(視為卡住)時,不論逾時值皆不再啟動新df。 全部代號皆不存在時回傳空陣列;全部失敗且有逾時或其他錯誤時reject,df執行失敗或解析不出任何一列時亦reject。

    限制:

    1. Windows之statfs經libuv執行緒池執行且無法取消,timeoutDrive含排隊時間;每個無回應之磁碟代號(如伺服器不可達之網路磁碟,實測約21秒後系統才放棄)佔用一條執行緒至系統放棄,同時無回應者達UV_THREADPOOL_SIZE(預設4)時,宿主程序之非同步fs、dns、crypto、zlib皆須等待,可於啟動Node前以環境變數調高UV_THREADPOOL_SIZE。
    2. Windows下Node.js<24.16(含18.x、20.x、22.x、25.x)之statfs以32位元回傳配置單位數,配置單位數超過4294967295之磁碟(如以1KiB為單位、大於4TiB之Samba/NAS網路磁碟,或4KiB叢集、大於16TiB之ReFS)容量會被截斷;NTFS磁碟不受影響。
    3. 非Windows平台之df僅於正常結束(含部分掛載點無法讀取之非0離開碼)時採用其輸出,被逾時中止或輸出超過10MB時視為失敗。
Source:
Example
import getDisksInfo from './src/getDisksInfo.mjs'

let r = await getDisksInfo()
console.log(r)
// => [
//   {
//     name: 'C:',
//     display: '',
//     total: 204936835072,
//     free: 34902945792,
//     used: 170033889280
//   }
// ]
Parameters:
Name Type Attributes Default Description
opt Object <optional>
{}

輸入設定物件,預設{}

Properties
Name Type Attributes Default Description
timeout Integer <optional>
10000

輸入非Windows平台執行df之逾時時間數字,單位ms,未給、非數值、非有限數(如'abc'、NaN、Infinity)或非正數時用預設,超過上限2147483647時以上限計,預設10000

timeoutDrive Integer <optional>
3000

輸入Windows平台查詢單一磁碟之逾時時間數字,單位ms,逾時之磁碟略過,未給、非數值、非有限數(如'abc'、NaN、Infinity)或非正數時用預設,超過上限2147483647時以上限計,預設3000

platform String <optional>
process.platform

輸入平台字串,供測試注入,預設process.platform

statfs function <optional>
fs.promises.statfs

輸入查詢磁碟之函數,供測試注入,未給或給undefined時用預設,給null視為不可用,預設fs.promises.statfs

execFile function <optional>
child_process.execFile

輸入執行外部程式之函數,供測試注入,預設child_process.execFile

Returns:

回傳Promise,resolve回傳磁碟資訊物件陣列,各物件含name(Windows為磁碟代號如'C:',其他平台為掛載點)、display(Windows為空字串,其他平台為df之檔案系統名稱)、total、free、used(單位皆為byte),reject回傳錯誤訊息

Type
Promise