Node.js fsPromises.readFile(path[, options])用法及代碼示例

fsPromises.readFile(path[, options])

參數

• path <string> | <Buffer> | <URL> | <FileHandle> 文件名或FileHandle
• options <Object>|<string>
  • encoding <string> | <null> 默認： null
  • flag <string>參看支持文件係統flags.默認： 'r'.
  • signal <AbortSignal> 允許中止 in-progress 讀取文件
• 返回： <Promise> 滿足文件的內容。

異步讀取文件的全部內容。

如果未指定編碼(使用 options.encoding )，則數據作為 <Buffer> 對象返回。否則，數據將是一個字符串。

如果options 是字符串，則它指定編碼。

當path 是目錄時，fsPromises.readFile() 的行為是特定於平台的。在 macOS、Linux 和 Windows 上，promise 將被拒絕並出現錯誤。在 FreeBSD 上，將返回目錄內容的表示。

可以使用 <AbortSignal> 中止正在進行的 readFile 。如果請求被中止，則返回的承諾將被拒絕，並帶有 AbortError ：

import { readFile } from 'node:fs/promises';

try {
  const controller = new AbortController();
  const { signal } = controller;
  const promise = readFile(fileName, { signal });

  // Abort the request before the promise settles.
  controller.abort();

  await promise;
} catch (err) {
  // When a request is aborted - err is an AbortError
  console.error(err);
}

中止正在進行的請求不會中止單個操作係統請求，而是執行內部緩衝fs.readFile。

任何指定的 <FileHandle> 都必須支持讀取。