Skip to main content

realpath

function realpath
Jump to headingrealpath(
path: PathLike,
options?:
ObjectEncodingOptions
| BufferEncoding
| null
,
): Promise<string>

Determines the actual location of path using the same semantics as the fs.realpath.native() function.

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. 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 Jump to heading

optional
Jump to headingoptions:
ObjectEncodingOptions
| BufferEncoding
| null

Return Type Jump to heading

Promise<string>

Fulfills with the resolved path upon success.

Jump to headingrealpath(): Promise<Buffer>

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

Parameters Jump to heading

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

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

Return Type Jump to heading

Promise<Buffer>
Jump to headingrealpath(
path: PathLike,
options?:
ObjectEncodingOptions
| BufferEncoding
| null
,
): Promise<string | Buffer>

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

Parameters Jump to heading

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

optional
Jump to headingoptions:
ObjectEncodingOptions
| BufferEncoding
| null

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

Return Type Jump to heading

Promise<string | Buffer>
Back to top