Function readlink

readlink(path: PathLike, options: "fs".EncodingOption, callback: ((err: SystemError, 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.

Since
v0.0.67
Parameters
- path: PathLike
- options: "fs".EncodingOption
- callback: ((err: SystemError, linkString: string) => void)
  - - (err: SystemError, linkString: string): void
    - Parameters
      
      err: SystemError
      
      linkString: string
      
      Returns void
Returns void
readlink(path: PathLike, options: BufferEncodingOption, callback: ((err: SystemError, linkString: "buffer".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: SystemError, linkString: "buffer".Buffer) => void)
  - - (err: SystemError, linkString: "buffer".Buffer): void
    - Parameters
      
      err: SystemError
      
      linkString: "buffer".Buffer
      
      Returns void
Returns void
readlink(path: PathLike, options: "fs".EncodingOption, callback: ((err: SystemError, linkString: string | "buffer".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: "fs".EncodingOption
  
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
- callback: ((err: SystemError, linkString: string | "buffer".Buffer) => void)
  - - (err: SystemError, linkString: string | "buffer".Buffer): void
    - Parameters
      
      err: SystemError
      
      linkString: string | "buffer".Buffer
      
      Returns void
Returns void
readlink(path: PathLike, callback: ((err: SystemError, 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: SystemError, linkString: string) => void)
  - - (err: SystemError, linkString: string): void
    - Parameters
      
      err: SystemError
      
      linkString: string
      
      Returns void
Returns void
readlink(path: PathLike, options: "fs".EncodingOption, callback: ((err: SystemError, 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.

Since
v0.0.67
Parameters
- path: PathLike
- options: "fs".EncodingOption
- callback: ((err: SystemError, linkString: string) => void)
  - - (err: SystemError, linkString: string): void
    - Parameters
      
      err: SystemError
      
      linkString: string
      
      Returns void
Returns void
readlink(path: PathLike, options: BufferEncodingOption, callback: ((err: SystemError, linkString: "buffer".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: SystemError, linkString: "buffer".Buffer) => void)
  - - (err: SystemError, linkString: "buffer".Buffer): void
    - Parameters
      
      err: SystemError
      
      linkString: "buffer".Buffer
      
      Returns void
Returns void
readlink(path: PathLike, options: "fs".EncodingOption, callback: ((err: SystemError, linkString: string | "buffer".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: "fs".EncodingOption
  
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
- callback: ((err: SystemError, linkString: string | "buffer".Buffer) => void)
  - - (err: SystemError, linkString: string | "buffer".Buffer): void
    - Parameters
      
      err: SystemError
      
      linkString: string | "buffer".Buffer
      
      Returns void
Returns void
readlink(path: PathLike, callback: ((err: SystemError, 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: SystemError, linkString: string) => void)
  - - (err: SystemError, linkString: string): void
    - Parameters
      
      err: SystemError
      
      linkString: string
      
      Returns void
Returns void

Function readlink

Since

Parameters

path: PathLike

options: "fs".EncodingOption

callback: ((err: SystemError, linkString: string) => void)

Parameters

err: SystemError

linkString: string

Returns void

Returns void

Parameters

path: PathLike

options: BufferEncodingOption

callback: ((err: SystemError, linkString: "buffer".Buffer) => void)

Parameters

err: SystemError

linkString: "buffer".Buffer

Returns void

Returns void

Parameters

path: PathLike

options: "fs".EncodingOption

callback: ((err: SystemError, linkString: string | "buffer".Buffer) => void)

Parameters

err: SystemError

linkString: string | "buffer".Buffer

Returns void

Returns void

Parameters

path: PathLike

callback: ((err: SystemError, linkString: string) => void)

Parameters

err: SystemError

linkString: string

Returns void

Returns void

Since

Parameters

path: PathLike

options: "fs".EncodingOption

callback: ((err: SystemError, linkString: string) => void)

Parameters

err: SystemError

linkString: string

Returns void

Returns void

Parameters

path: PathLike

options: BufferEncodingOption

callback: ((err: SystemError, linkString: "buffer".Buffer) => void)

Parameters

err: SystemError

linkString: "buffer".Buffer

Returns void

Returns void

Parameters

path: PathLike

options: "fs".EncodingOption

callback: ((err: SystemError, linkString: string | "buffer".Buffer) => void)

Parameters

err: SystemError

linkString: string | "buffer".Buffer

Returns void

Returns void

Parameters

path: PathLike

callback: ((err: SystemError, linkString: string) => void)

Parameters

err: SystemError

linkString: string

Returns void

Returns void

Settings

Member Visibility

Theme