Function readlink

readlink(
    path: PathLike,
    options: EncodingOption,
    callback: (err: ErrnoException, 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.
Parameters
- path: PathLike
- options: EncodingOption
- callback: (err: ErrnoException, linkString: string) => void
Returns void
Since
v0.1.31
- Defined in node_modules/@types/node/fs.d.ts:1310
readlink(
    path: PathLike,
    options: BufferEncodingOption,
    callback: (err: ErrnoException, linkString: Buffer) => void,
): void
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.
- callback: (err: ErrnoException, linkString: Buffer) => void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1320
readlink(
    path: PathLike,
    options: EncodingOption,
    callback: (
        err: ErrnoException,
        linkString: string | Buffer<ArrayBufferLike>,
    ) => void,
): void
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: 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, linkString: string | Buffer<ArrayBufferLike>) => void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1330
readlink(
path: PathLike,
callback: (err: ErrnoException, linkString: string) => void,
): void
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.
- callback: (err: ErrnoException, linkString: string) => void
Returns void
- Defined in node_modules/@types/node/fs.d.ts:1339

Function readlink

Parameters

Returns void

Since

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Settings