Function open

  • 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

      See support of file system flags``.

    • Optional mode: Mode

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

    Returns Promise<FileHandle>

    Fulfills with a {FileHandle} object.

    Since

    v10.0.0

Generated using TypeDoc