Node fs.promises.lstat function | API Reference

function lstat(

opts?: StatOptions & { bigint: false }

): Promise<Stats>;

Equivalent to fsPromises.stat() unless path refers to a symbolic link, in which case the link itself is stat-ed, not the file that it refers to. Refer to the POSIX lstat(2) document for more detail.

@returns

Fulfills with the {fs.Stats} object for the given symbolic link path.

function lstat(

path: PathLike,

opts: StatOptions & { bigint: true }

): Promise<BigIntStats>;

Equivalent to fsPromises.stat() unless path refers to a symbolic link, in which case the link itself is stat-ed, not the file that it refers to. Refer to the POSIX lstat(2) document for more detail.

@returns

Fulfills with the {fs.Stats} object for the given symbolic link path.

function lstat(

path: PathLike,

opts?: StatOptions

): Promise<Stats | BigIntStats>;

Equivalent to fsPromises.stat() unless path refers to a symbolic link, in which case the link itself is stat-ed, not the file that it refers to. Refer to the POSIX lstat(2) document for more detail.

@returns

Fulfills with the {fs.Stats} object for the given symbolic link path.