Skip to main content
readlinkSync - node__fs.d.ts - Node documentation
function readlinkSync

Usage in Deno

```typescript import { readlinkSync } from "node:node__fs.d.ts"; ```
readlinkSync(
path: PathLike,
options?: EncodingOption,
): string
Returns the symbolic link's string value. See the POSIX [`readlink(2)`](http://man7.org/linux/man-pages/man2/readlink.2.html) 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
optional
options: EncodingOption

Return Type

string
readlinkSync(): 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.
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.

Return Type

Buffer
readlinkSync(
path: PathLike,
options?: EncodingOption,
): string | 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.
optional
options: EncodingOption
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