Options
All
  • Public
  • Public/Protected
  • All
Menu

Callable

  • 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: BaseEncodingOptions | BufferEncoding | undefined | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    • callback: function

    Returns 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: function

    Returns 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: BaseEncodingOptions | string | undefined | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    • callback: function

    Returns 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: function

    Returns void

Index

Functions

Functions

__promisify__

  • 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.

    • Optional options: BaseEncodingOptions | BufferEncoding | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns Promise<string>

  • 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>

  • 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.

    • Optional options: BaseEncodingOptions | string | null

      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>

Generated using TypeDoc