Function readlinkSync

readlinkSync(path, options?): string
Returns the symbolic link's string value.

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 returned. If the encoding is set to 'buffer', the link path returned will be passed as a Buffer object.
Parameters
- path: PathLike
- Optional options: EncodingOption
Returns string

Since
v0.1.31
- Defined in node_modules/@types/node/fs.d.ts:1394
readlinkSync(path, options): Buffer
Synchronous 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 Buffer
- Defined in node_modules/@types/node/fs.d.ts:1400
readlinkSync(path, options?): string | Buffer
Synchronous 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.
- Optional options: EncodingOption
  
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns string | Buffer
- Defined in node_modules/@types/node/fs.d.ts:1406

Generated using TypeDoc