Node.js fs.writeFile(file, data[, options], callback)用法及代码示例

fs.writeFile(file, data[, options], callback)

参数

• file <string> | <Buffer> | <URL> | <integer> 文件名或文件说明符
• data <string> | <Buffer> | <TypedArray> | <DataView> | <Object>
• options <Object>|<string>
  • encoding <string> | <null> 默认： 'utf8'
  • mode <integer> 默认： 0o666
  • flag <string>参看支持文件系统flags.默认： 'w'.
  • signal <AbortSignal> 允许中止 in-progress writeFile
• callback <Function>
  • err <Error> | <AggregateError>

当file 是文件名时，异步将数据写入文件，如果文件已存在则替换该文件。 data 可以是字符串或缓冲区。

当file 是文件说明符时，行为类似于直接调用fs.write()(推荐)。请参阅下面有关使用文件说明符的说明。

如果 data 是缓冲区，则忽略 encoding 选项。

mode 选项仅影响新创建的文件。有关详细信息，请参阅 fs.open() 。

import { writeFile } from 'node:fs';
import { Buffer } from 'node:buffer';

const data = new Uint8Array(Buffer.from('Hello Node.js'));
writeFile('message.txt', data, (err) => {
  if (err) throw err;
  console.log('The file has been saved!');
});

如果options 是字符串，则它指定编码：

import { writeFile } from 'node:fs';

writeFile('message.txt', 'Hello Node.js', 'utf8', callback);

在同一个文件上多次使用fs.writeFile()而不等待回调是不安全的。对于这种情况，建议使用 fs.createWriteStream() 。

类似于fs.readFile - fs.writeFile 是一种方便的方法，它在内部执行多个 write 调用以写入传递给它的缓冲区。对于性能敏感的代码，请考虑使用 fs.createWriteStream() 。

可以使用 <AbortSignal> 取消 fs.writeFile() 。取消是"best effort"，可能还有一些数据需要写入。

import { writeFile } from 'node:fs';
import { Buffer } from 'node:buffer';

const controller = new AbortController();
const { signal } = controller;
const data = new Uint8Array(Buffer.from('Hello Node.js'));
writeFile('message.txt', data, { signal }, (err) => {
  // When a request is aborted - the callback is called with an AbortError
});
// When the request should be aborted
controller.abort();

中止正在进行的请求不会中止单个操作系统请求，而是执行内部缓冲fs.writeFile。