Skip to main content

realpathSync

function realpathSync
Jump to headingrealpathSync(
path: PathLike,
options?: EncodingOption,
): string

Returns the resolved pathname.

For detailed information, see the documentation of the asynchronous version of this API: realpath.

Parameters Jump to heading

Return Type Jump to heading

string
Jump to headingrealpathSync(): Buffer

Synchronous 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

Buffer
Jump to headingrealpathSync(
path: PathLike,
options?: EncodingOption,
): string | Buffer

Synchronous 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

string | Buffer
Back to top