realpath - node__fs.d.ts - Node

function realpath

Usage in Deno

```typescript import { realpath } from "node:node__fs.d.ts"; ```



realpath(path: PathLike,
options: EncodingOption,
callback: (err: ErrnoException | null,
resolvedPath: string,
) => void,
): 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)`](http://man7.org/linux/man-pages/man3/realpath.3.html), 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)`](http://man7.org/linux/man-pages/man3/realpath.3.html) implementation supports. The `callback` gets two arguments `(err, resolvedPath)`. May use `process.cwd` to 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



options: EncodingOption



callback: (err: ErrnoException | null,
resolvedPath: string,
) => void

Return Type

void



realpath(path: PathLike,
options: BufferEncodingOption,
callback: (err: ErrnoException | null,
resolvedPath: Buffer,
) => void,
): 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: BufferEncodingOption

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



callback: (err: ErrnoException | null,
resolvedPath: Buffer,
) => void

Return Type

void



realpath(path: PathLike,
options: EncodingOption,
callback: (err: ErrnoException | null,
resolvedPath: string | Buffer,
) => void,
): 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: EncodingOption

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



callback: (err: ErrnoException | null,
resolvedPath: string | Buffer,
) => void

Return Type

void



realpath(path: PathLike,
callback: (err: ErrnoException | null,
resolvedPath: string,
) => void,
): 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: (err: ErrnoException | null,
resolvedPath: string,
) => void

Return Type

void

namespace realpath

Functions

realpath.native

Asynchronous [`realpath(3)`](http://man7.org/linux/man-pages/man3/realpath.3.html). 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.