Function readlink

  • readlink(path, options, callback): void

  • Reads the contents of the symbolic link referred to by path. The callback gets two arguments (err, linkString).

    See the POSIX readlink(2) documentation for more details.

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

    Parameters

    Returns void

    Since

    v0.1.31

  • readlink(path, options, callback): void

  • 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.

    • callback: ((err, linkString) => void)

    Returns void

  • readlink(path, options, callback): void

  • 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: EncodingOption

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

    • callback: ((err, linkString) => void)

    Returns void

  • readlink(path, callback): void

  • 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.

    • callback: ((err, linkString) => void)
        • (err, linkString): void

        • Parameters

          Returns void

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc