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。