Jump to headingreadlinkSync(path: PathLike,options?: EncodingOption,): stringReturns 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 Jump to heading
Jump to headingpath: PathLikeJump to headingoptions: EncodingOptionReturn Type Jump to heading
stringJump to headingreadlinkSync(path: PathLike,options: BufferEncodingOption,): BufferSynchronous 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
BufferJump to headingreadlinkSync(path: PathLike,options?: EncodingOption,): string | BufferSynchronous 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: EncodingOptionThe 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
string | Buffer