open

function open

Usage

import { open } from "node:fs/promises";


        open(path: PathLike, flags?: string | number, mode?: Mode): Promise<FileHandle>

Opens a FileHandle.

Refer to the POSIX open(2) documentation for more detail.

Some characters (< > : " / \ | ? *) are reserved under Windows as documented by Naming Files, Paths, and Namespaces. Under NTFS, if the filename contains a colon, Node.js will open a file system stream, as described by this MSDN page.

Parameters

path: PathLike

optional

flags: string | number = 'r'

See support of file system flags``.

optional

mode: Mode = 0o666

Sets the file mode (permission and sticky bits) if the file is created.

Return Type

Promise<FileHandle>

Fulfills with a {FileHandle} object.