filename or FileHandle
Optional options: "fs".WriteFileOptionsAsynchronously writes data to a file, replacing the file if it already exists.data can be a string, a buffer, an
AsyncIterable or
Iterable 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.
import { writeFile } from "fs/promises";
import { Buffer } from "buffer";
try {
const controller = new AbortController();
const { signal } = controller;
const data = new Uint8Array(Buffer.from("Hello Node.js"));
const promise = writeFile("message.txt", data, { 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);
}
Aborting an ongoing request does not abort individual operating
system requests but rather the internal buffering fs.writeFile performs.
v0.0.67
Fulfills with undefined upon success.
filename or FileHandle
Optional options: "fs".WriteFileOptionsGenerated using TypeDoc
Asynchronously writes data to a file, replacing the file if it already exists.
datacan be a string, a buffer, an AsyncIterable or Iterable object.The
encodingoption is ignored ifdatais a buffer.If
optionsis a string, then it specifies the encoding.The
modeoption only affects the newly created file. Seefs.open()for more details.Any specified
FileHandlehas 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.writeFileis a convenience method that performs multiplewritecalls internally to write the buffer passed to it. For performance sensitive code consider usingfs.createWriteStream()orfilehandle.createWriteStream().It is possible to use an
AbortSignalto cancel anfsPromises.writeFile(). Cancelation is "best effort", and some amount of data is likely still to be written.Aborting an ongoing request does not abort individual operating system requests but rather the internal buffering
fs.writeFileperforms.Since
v0.0.67
Returns
Fulfills with
undefinedupon success.