Skip to content

Realpath

[<Interface>]
type Realpath =
    abstract member Invoke (path: PathLike, callback: Callback4) : unit
    abstract member Invoke (path: PathLike, options: EncodingOption, callback: Callback3) : unit
    abstract member Invoke (path: PathLike, options: BufferEncodingOption, callback: Callback2) : unit
    abstract member Invoke (path: PathLike, options: EncodingOption, callback: Callback) : unit
    abstract member __promisify__ (path: PathLike, options: BufferEncodingOption) : Promise<NonSharedBuffer>
    abstract member __promisify__ (path: PathLike, ?options: EncodingOption) : Promise<string>
    abstract member native (path: PathLike, callback: Callback4) : unit
    abstract member native (path: PathLike, options: EncodingOption, callback: Callback3) : unit
    abstract member native (path: PathLike, options: BufferEncodingOption, callback: Callback2) : unit
    abstract member native (path: PathLike, options: EncodingOption, callback: Callback) : unit
AssemblyXantham.Fable.Node

Declared inside

Callback
Callback2
Callback3
Callback4
Native

Methods

abstract member Invoke (path: PathLike, callback: Callback4) : unit

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.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. Asynchronous realpath(3) - return the canonicalized absolute pathname.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
abstract member Invoke (path: PathLike, options: EncodingOption, callback: Callback3) : unit

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.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. Asynchronous realpath(3) - return the canonicalized absolute pathname.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
abstract member Invoke (path: PathLike, options: BufferEncodingOption, callback: Callback2) : unit

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.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. Asynchronous realpath(3) - return the canonicalized absolute pathname.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
abstract member Invoke (path: PathLike, options: EncodingOption, callback: Callback) : unit

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.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. Asynchronous realpath(3) - return the canonicalized absolute pathname.

@since v0.1.31

abstract member __promisify__ (path: PathLike, options: BufferEncodingOption) : Promise<NonSharedBuffer>

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

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
abstract member __promisify__ (path: PathLike, ?options: EncodingOption) : Promise<string>

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

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
abstract member native (path: PathLike, callback: Callback4) : unit

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.

@since v9.2.0

abstract member native (path: PathLike, options: EncodingOption, callback: Callback3) : unit

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.

@since v9.2.0

abstract member native (path: PathLike, options: BufferEncodingOption, callback: Callback2) : unit

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.

@since v9.2.0

abstract member native (path: PathLike, options: EncodingOption, callback: Callback) : unit

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.

@since v9.2.0