Function readlink

  • readlink(path, options?): Promise<string>

  • Reads the contents of the symbolic link referred to by path. See the POSIX readlink(2) documentation for more detail. The promise is fulfilled with thelinkString upon success.

    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 link path returned. If the encoding is set to 'buffer', the link path returned will be passed as a Buffer object.

    Parameters

    Returns Promise<string>

    Fulfills with the linkString upon success.

    Since

    v10.0.0

  • readlink(path, options): Promise<Buffer>

  • Asynchronous readlink(2) - read value of a symbolic link.

    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>

  • readlink(path, options?): Promise<string | Buffer>

  • Asynchronous readlink(2) - read value of a symbolic link.

    Parameters

    • path: PathLike

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

    • Optional options: null | string | 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