promises.realpath - fs - Node

function promises.realpath

Usage in Deno

import { promises } from "node:fs";



realpath(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



path: PathLike

optional



options: ObjectEncodingOptions
 | BufferEncoding
 | null

Return Type

Promise<string>

Fulfills with the resolved path upon success.



realpath(path: PathLike,
options: BufferEncodingOption,
): 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.

Return Type

Promise<Buffer>



realpath(path: PathLike,
options?: ObjectEncodingOptions
 | BufferEncoding
 | 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: 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

Promise<string | Buffer>