function open

#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

#flags: string | number = 'r'

optional

See support of file system flags``.

#mode: Mode = 0o666

optional

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

Return Type #

Promise<FileHandle>

Fulfills with a {FileHandle} object.