function

fs.promises.open

function 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.

@param flags

See support of file system flags``.

@param mode

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

@returns

Fulfills with a {FileHandle} object.