Skip to main content
promises.FileHandle.writeFile - fs - Node documentation
method promises.FileHandle.writeFile

Usage in Deno

import { type promises } from "node:fs";
FileHandle.writeFile(
data: string | Uint8Array,
options?:
(
ObjectEncodingOptions
& FlagAndOpenMode
& Abortable
& { flush?: boolean | undefined; }
)

| BufferEncoding
| null
,
): Promise<void>

Asynchronously writes data to a file, replacing the file if it already exists. data can be a string, a buffer, an AsyncIterable, or an Iterable object. The promise is fulfilled with no arguments upon success.

If options is a string, then it specifies the encoding.

The FileHandle has to support writing.

It is unsafe to use filehandle.writeFile() multiple times on the same file without waiting for the promise to be fulfilled (or rejected).

If one or more filehandle.write() calls are made on a file handle and then afilehandle.writeFile() call is made, the data will be written from the current position till the end of the file. It doesn't always write from the beginning of the file.

Parameters

data: string | Uint8Array
optional
options:
(
ObjectEncodingOptions
& FlagAndOpenMode
& Abortable
& { flush?: boolean | undefined; }
)

| BufferEncoding
| null

Return Type

Promise<void>