Function realpath

  • Determines the actual location of path using the same semantics as thefs.realpath.native() function.

    Only paths that can be converted to UTF8 strings are supported.

    The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the path. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    On Linux, when Node.js is linked against musl libc, the procfs file system must be mounted on /proc in order for this function to work. Glibc does not have this restriction.

    Parameters

    Returns Promise<string>

    Fulfills with the resolved path upon success.

    Since

    v10.0.0

  • Asynchronous realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: BufferEncodingOption

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns Promise<Buffer>

  • Asynchronous realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: BufferEncoding | ObjectEncodingOptions

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns Promise<string | Buffer>

Settings

Member Visibility

Theme

Generated using TypeDoc