Function open

open(path: PathLike, flags?: "fs".OpenMode, mode?: "fs".Mode): Promise<number>
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.

Since
v0.0.67

Returns
Fulfills with a {FileHandle} object.
Parameters
- path: PathLike
- Optional flags: "fs".OpenMode
  
  See support of file system flags``.
- Optional mode: "fs".Mode
  
  Sets the file mode (permission and sticky bits) if the file is created.
Returns Promise<number>
open(path: PathLike, flags?: "fs".OpenMode, mode?: "fs".Mode): Promise<number>
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.

Since
v0.0.67

Returns
Fulfills with a {FileHandle} object.
Parameters
- path: PathLike
- Optional flags: "fs".OpenMode
  
  See support of file system flags``.
- Optional mode: "fs".Mode
  
  Sets the file mode (permission and sticky bits) if the file is created.
Returns Promise<number>

Generated using TypeDoc