readlink - node__fs--promises.d.ts - Node

function readlink

Usage in Deno

```typescript import { readlink } from "node:node__fs--promises.d.ts"; ```



readlink(path: PathLike,
options?: ObjectEncodingOptions
 | BufferEncoding
 | null,
): Promise<string>

Reads the contents of the symbolic link referred to by `path`. See the POSIX [`readlink(2)`](http://man7.org/linux/man-pages/man2/readlink.2.html) documentation for more detail. The promise is fulfilled with the`linkString` upon success. 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: ObjectEncodingOptions
 | BufferEncoding
 | null

Return Type

Promise<string>

Fulfills with the `linkString` upon success.



readlink(path: PathLike,
options: BufferEncodingOption,
): Promise<Buffer>

Asynchronous 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.

Return Type

Promise<Buffer>



readlink(path: PathLike,
options?: ObjectEncodingOptions
 | string
 | null,
): Promise<string | Buffer>

Asynchronous 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: ObjectEncodingOptions
 | string
 | null

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

Return Type

Promise<string | Buffer>