Jump to headingreadlink(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 Jump to heading
Jump to headingpath: PathLikeJump to headingoptions: Return Type Jump to heading
Promise<string>Fulfills with the linkString upon success.
Jump to headingreadlink(path: PathLike,options: BufferEncodingOption,): Promise<Buffer>Asynchronous readlink(2) - read value of a symbolic link.
Parameters Jump to heading
Jump to headingpath: PathLikeA path to a file. If a URL is provided, it must use the file: protocol.
Jump to headingoptions: BufferEncodingOptionThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Return Type Jump to heading
Promise<Buffer>Jump to headingreadlink(path: PathLike,options?: ,): Promise<string | Buffer>Asynchronous readlink(2) - read value of a symbolic link.
Parameters Jump to heading
Jump to headingpath: PathLikeA path to a file. If a URL is provided, it must use the file: protocol.
Jump to headingoptions: The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Return Type Jump to heading
Promise<string | Buffer>