function readlink
Overload 1
#readlink(path: PathLike,options: EncodingOption,callback: (err: ErrnoException | null,linkString: string,) => void,): voidReads 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.
Parameters #
#options: EncodingOption #callback: (err: ErrnoException | null,linkString: string,) => void Return Type #
void Overload 2
#readlink(path: PathLike,options: BufferEncodingOption,callback: (err: ErrnoException | null,linkString: Buffer,) => void,): voidAsynchronous readlink(2) - read value of a symbolic link.
Parameters #
#options: BufferEncodingOption The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
#callback: (err: ErrnoException | null,linkString: Buffer,) => void Return Type #
void Overload 3
#readlink(path: PathLike,options: EncodingOption,callback: (err: ErrnoException | null,linkString: string | Buffer,) => void,): voidAsynchronous readlink(2) - read value of a symbolic link.
Parameters #
#options: EncodingOption The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
#callback: (err: ErrnoException | null,linkString: string | Buffer,) => void Return Type #
void