Function readlink

readlink(
path: PathLike,
options?: 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.
Parameters
- path: PathLike
- Optionaloptions: BufferEncoding | ObjectEncodingOptions
Returns Promise<string>
Fulfills with the linkString upon success.

Since
v10.0.0
- Defined in node_modules/@types/node/fs/promises.d.ts:745
readlink(
path: PathLike,
options: BufferEncodingOption,
): Promise<Buffer<ArrayBufferLike>>
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.
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/@types/node/fs/promises.d.ts:751
readlink(
path: PathLike,
options?: string | ObjectEncodingOptions,
): Promise<string | Buffer<ArrayBufferLike>>
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.
- Optionaloptions: string | ObjectEncodingOptions
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns Promise<string | Buffer<ArrayBufferLike>>
- Defined in node_modules/@types/node/fs/promises.d.ts:757

Function readlink

Parameters

Returns Promise<string>

Since

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Parameters

Returns Promise<string | Buffer<ArrayBufferLike>>

Settings