Function readlinkSync

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.
Parameters
- path: PathLike
- Optionaloptions: EncodingOption
Returns string
Since
v0.1.31
- Defined in node_modules/@types/node/fs.d.ts:1374
readlinkSync(path: PathLike, options: BufferEncodingOption): Buffer
Synchronous readlink(2) - read value of a symbolic link.
Parameters
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- options: BufferEncodingOption
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns Buffer
- Defined in node_modules/@types/node/fs.d.ts:1380
readlinkSync(
path: PathLike,
options?: EncodingOption,
): string | Buffer<ArrayBufferLike>
Synchronous readlink(2) - read value of a symbolic link.
Parameters
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optionaloptions: EncodingOption
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns string | Buffer<ArrayBufferLike>
- Defined in node_modules/@types/node/fs.d.ts:1386

Function readlinkSync

Parameters

Returns string

Since

Parameters

Returns Buffer

Parameters

Returns string | Buffer<ArrayBufferLike>

Settings