readlinkAsync

external fun readlinkAsync(path: PathLike): Promise<String>(source)
external fun readlinkAsync(path: PathLike, options: ObjectEncodingOptions? = definedExternally): Promise<String>(source)
external fun readlinkAsync(path: PathLike, options: BufferEncoding? = definedExternally): Promise<String>(source)

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.

Since

v10.0.0

Return

Fulfills with the linkString upon success.


external fun readlinkAsync(path: PathLike, options: String? = definedExternally): Promise<Any>(source)

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

Parameters

path

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

options

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