function readlink
Overload 1
#readlink(path: PathLike,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 #
#options: optional
Return Type #
Promise<string> Fulfills with the linkString upon success.
Overload 2
#readlink(path: PathLike,options: BufferEncodingOption,): Promise<Buffer>Asynchronous readlink(2) - read value of a symbolic link.
Parameters #
#options: BufferEncodingOption The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Return Type #
Promise<Buffer> Overload 3
#readlink(path: PathLike,options?: ,): Promise<string | Buffer>