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