Options
All
  • Public
  • Public/Protected
  • All
Menu

Module realpath

Callable

  • realpath(path: PathLike, options: object | BufferEncoding | undefined | null, callback: function): void
  • realpath(path: PathLike, options: object | "buffer", callback: function): void
  • realpath(path: PathLike, options: object | string | undefined | null, callback: function): void
  • realpath(path: PathLike, callback: function): void

  • Asynchronous realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: object | 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 realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: object | "buffer"

      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 realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: object | 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

        • Parameters

          Returns void

    Returns void

  • Asynchronous realpath(3) - return the canonicalized absolute pathname.

    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__

  • __promisify__(path: PathLike, options?: object | BufferEncoding | null): Promise<string>
  • __promisify__(path: PathLike, options: object | "buffer"): Promise<Buffer>
  • __promisify__(path: PathLike, options?: object | string | null): Promise<string | Buffer>

  • Asynchronous realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: object | 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 realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: object | "buffer"

      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 realpath(3) - return the canonicalized absolute pathname.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: object | 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>

native

  • native(path: PathLike, options: object | BufferEncoding | undefined | null, callback: function): void
  • native(path: PathLike, options: object | "buffer", callback: function): void
  • native(path: PathLike, options: object | string | undefined | null, callback: function): void
  • native(path: PathLike, callback: function): void

  • Parameters

    Returns void

  • Parameters

    • path: PathLike
    • options: object | "buffer"
    • callback: function

    Returns void

  • Parameters

    • path: PathLike
    • options: object | string | undefined | null
    • callback: function

        • Parameters

          Returns void

    Returns void

  • Parameters

    Returns void

Generated using TypeDoc