Function realpath

  • realpath(path, options, callback): void

  • Asynchronously computes the canonical pathname by resolving ., .., and symbolic links.

    A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames.

    This function behaves like realpath(3), with some exceptions:

    1. No case conversion is performed on case-insensitive file systems.
    2. The maximum number of symbolic links is platform-independent and generally (much) higher than what the native realpath(3) implementation supports.

    The callback gets two arguments (err, resolvedPath). May use process.cwdto resolve relative paths.

    Only paths that can be converted to UTF8 strings are supported.

    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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    If path resolves to a socket or a pipe, the function will return a system dependent name for that object.

    Parameters

    Returns void

    Since

    v0.1.31

    See

  • realpath(path, options, callback): void

  • Asynchronously computes the canonical pathname by resolving ., .., and symbolic links.

    A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames.

    This function behaves like realpath(3), with some exceptions:

    1. No case conversion is performed on case-insensitive file systems.
    2. The maximum number of symbolic links is platform-independent and generally (much) higher than what the native realpath(3) implementation supports.

    The callback gets two arguments (err, resolvedPath). May use process.cwdto resolve relative paths.

    Only paths that can be converted to UTF8 strings are supported.

    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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    If path resolves to a socket or a pipe, the function will return a system dependent name for that object.

    Parameters

    Returns void

    Since

    v0.1.31

    See

  • realpath(path, options, callback): void

  • Asynchronously computes the canonical pathname by resolving ., .., and symbolic links.

    A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames.

    This function behaves like realpath(3), with some exceptions:

    1. No case conversion is performed on case-insensitive file systems.
    2. The maximum number of symbolic links is platform-independent and generally (much) higher than what the native realpath(3) implementation supports.

    The callback gets two arguments (err, resolvedPath). May use process.cwdto resolve relative paths.

    Only paths that can be converted to UTF8 strings are supported.

    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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    If path resolves to a socket or a pipe, the function will return a system dependent name for that object.

    Parameters

    Returns void

    Since

    v0.1.31

    See

  • realpath(path, callback): void

  • Asynchronously computes the canonical pathname by resolving ., .., and symbolic links.

    A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames.

    This function behaves like realpath(3), with some exceptions:

    1. No case conversion is performed on case-insensitive file systems.
    2. The maximum number of symbolic links is platform-independent and generally (much) higher than what the native realpath(3) implementation supports.

    The callback gets two arguments (err, resolvedPath). May use process.cwdto resolve relative paths.

    Only paths that can be converted to UTF8 strings are supported.

    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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    If path resolves to a socket or a pipe, the function will return a system dependent name for that object.

    Parameters

    • path: PathLike
    • callback: ((err, resolvedPath) => void)
        • (err, resolvedPath): void

        • Parameters

          Returns void

    Returns void

    Since

    v0.1.31

    See

  • realpath(path, options?): Promise<string>

  • Asynchronously computes the canonical pathname by resolving ., .., and symbolic links.

    A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames.

    This function behaves like realpath(3), with some exceptions:

    1. No case conversion is performed on case-insensitive file systems.
    2. The maximum number of symbolic links is platform-independent and generally (much) higher than what the native realpath(3) implementation supports.

    The callback gets two arguments (err, resolvedPath). May use process.cwdto resolve relative paths.

    Only paths that can be converted to UTF8 strings are supported.

    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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    If path resolves to a socket or a pipe, the function will return a system dependent name for that object.

    Parameters

    Returns Promise<string>

    Since

    v0.1.31

    See

  • realpath(path, options): Promise<Buffer>

  • Asynchronously computes the canonical pathname by resolving ., .., and symbolic links.

    A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames.

    This function behaves like realpath(3), with some exceptions:

    1. No case conversion is performed on case-insensitive file systems.
    2. The maximum number of symbolic links is platform-independent and generally (much) higher than what the native realpath(3) implementation supports.

    The callback gets two arguments (err, resolvedPath). May use process.cwdto resolve relative paths.

    Only paths that can be converted to UTF8 strings are supported.

    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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    If path resolves to a socket or a pipe, the function will return a system dependent name for that object.

    Parameters

    Returns Promise<Buffer>

    Since

    v0.1.31

    See

  • realpath(path, options?): Promise<string | Buffer>

  • Asynchronously computes the canonical pathname by resolving ., .., and symbolic links.

    A canonical pathname is not necessarily unique. Hard links and bind mounts can expose a file system entity through many pathnames.

    This function behaves like realpath(3), with some exceptions:

    1. No case conversion is performed on case-insensitive file systems.
    2. The maximum number of symbolic links is platform-independent and generally (much) higher than what the native realpath(3) implementation supports.

    The callback gets two arguments (err, resolvedPath). May use process.cwdto resolve relative paths.

    Only paths that can be converted to UTF8 strings are supported.

    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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

    If path resolves to a socket or a pipe, the function will return a system dependent name for that object.

    Parameters

    Returns Promise<string | Buffer>

    Since

    v0.1.31

    See

Properties

native

Methods

__promisify__

Properties

native

native: {
    (path, options, callback): void;
    (path, options, callback): void;
    (path, options, callback): void;
    (path, callback): void;
} & {
    (path, options): Promise<string>;
    (path, options): Promise<Buffer>;
    (path, options): Promise<string | Buffer>;
    (path): Promise<string>;
}

Type declaration

    • (path, options, callback): void

    • Asynchronous realpath(3).

      The callback gets two arguments (err, resolvedPath).

      Only paths that can be converted to UTF8 strings are supported.

      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 path passed to the callback. If the encoding is set to 'buffer', the path returned will be passed as a Buffer object.

      On Linux, when Node.js is linked against musl libc, the procfs file system must be mounted on /proc in order for this function to work. Glibc does not have this restriction.

      Parameters

      Returns void

      Since

      v9.2.0

    • (path, options, callback): void

    • Parameters

      Returns void

    • (path, options, callback): void

    • Parameters

      Returns void

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: ((err, resolvedPath) => void)
          • (err, resolvedPath): void

          • Parameters

            Returns void

      Returns void

Type declaration

Methods

__promisify__

  • __promisify__(path, options?): 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.

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

  • __promisify__(path, options): 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.

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

  • __promisify__(path, options?): 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: EncodingOption

      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>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc