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> 都必须支持读取。