writeFile

How does writeFile work?

Asynchronously writes data to a file, replacing the file if it already exists. data can be a string, a buffer, an AsyncIterable (opens in a new tab), or an Iterable (opens in a new tab) object. The encoding option is ignored if data is a buffer. If options is a string, then it specifies the encoding. The mode option only affects the newly created file. See fs.open() for more details. Any specified FileHandle has to support writing. It is unsafe to use fsPromises.writeFile() multiple times on the same file without waiting for the promise to be settled. Similarly to fsPromises.readFile - fsPromises.writeFile is a convenience method that performs multiple write calls internally to write the buffer passed to it. For performance sensitive code consider using fs.createWriteStream() or filehandle.createWriteStream(). It is possible to use an AbortSignal to cancel an fsPromises.writeFile(). Cancelation is "best effort", and some amount of data is likely still to be written. universal-fs uses fetch requests under the hood. A request can be aborted but beyond a certain point it can no longer be aborted.

Usage

import {writeFile} from "universal-fs";
import {Buffer} from "node:buffer";
try {
  const controller = new AbortController();
  const {signal} = controller;
  const promise = writeFile("message.txt", "Hello Node.js", {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);
}

Additional details

Aborting an ongoing request does not abort individual operating system requests but rather the internal buffering fs.writeFile performs.

• since universal-fs v1.0.0 | Node.js v10.0.0
• param file filename or FileHandle
• return Fulfills with undefined upon success.