readlinkSync
external fun readlinkSync(path: PathLike, options: EncodingOption = definedExternally): String(source)
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.
Since
v0.1.31
Synchronous readlink(2) - read value of a symbolic link.
Parameters
path
A path to a file. If a URL is provided, it must use the file:
protocol.
options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8'
is used.