function

fs.promises.readlink

options?: null | BufferEncoding | ObjectEncodingOptions

): Promise<string>;

Reads the contents of the symbolic link referred to by path. See the POSIX readlink(2) documentation for more detail. The promise is fulfilled with thelinkString 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.

@returns

Fulfills with the linkString upon success.

function readlink(

path: PathLike,

options: BufferEncodingOption

): Promise<NonSharedBuffer>;

Asynchronous 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 readlink(

path: PathLike,

options?: null | string | ObjectEncodingOptions

): Promise<string | NonSharedBuffer>;

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

interface ObjectEncodingOptions

encoding?: null | BufferEncoding

type BufferEncodingOption = 'buffer' | { encoding: 'buffer' }