Function readlinkSync

  • readlinkSync(path, options?): string

  • Returns the symbolic link's string value.

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

    Parameters

    Returns string

    Since

    v0.1.31

  • readlinkSync(path, options): Buffer

  • Synchronous 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 Buffer

  • readlinkSync(path, options?): string | Buffer

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

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

    Returns string | Buffer

Settings

Member Visibility

Theme

Generated using TypeDoc