Usage in Deno
import { readlink } from "node:fs";
readlink(path: PathLike,options: EncodingOption,callback: (err: ErrnoException | null,linkString: string,) => void,): void
Reads the contents of the symbolic link referred to by path
. The callback gets
two arguments (err, linkString)
.
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 passed to the callback. If the encoding
is set to 'buffer'
,
the link path returned will be passed as a Buffer
object.
path: PathLike
options: EncodingOption
void
readlink(path: PathLike,options: BufferEncodingOption,callback: (err: ErrnoException | null,linkString: Buffer,) => void,): void
Asynchronous readlink(2) - read value of a symbolic link.
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.
void
readlink(path: PathLike,options: EncodingOption,callback: (err: ErrnoException | null,linkString: string | Buffer,) => void,): void
Asynchronous readlink(2) - read value of a symbolic link.
path: PathLike
A path to a file. If a URL is provided, it must use the file:
protocol.
options: EncodingOption
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8'
is used.
void