function

fs.readlinkSync

function readlinkSync(
path: PathLike,
options?: EncodingOption
): string;

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.

function readlinkSync(
path: PathLike,
options: BufferEncodingOption
): NonSharedBuffer;

Synchronous readlink(2) - read value of a symbolic link.

@param path

A path to a file. If a URL is provided, it must use the file: protocol.

@param options

The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

function readlinkSync(
path: PathLike,
options?: EncodingOption
): string | NonSharedBuffer;

Synchronous readlink(2) - read value of a symbolic link.

@param path

A path to a file. If a URL is provided, it must use the file: protocol.

@param options

The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

Referenced types

type PathLike = string | Buffer | URL

Valid types for path values in "fs".

type EncodingOption =
| ObjectEncodingOptions
| BufferEncoding
| undefined
| null
type BufferEncodingOption = 'buffer' | { encoding: 'buffer' }