function lstat

Overload 1

#lstat(path: PathLike,
opts?: StatOptions & { bigint?: false | undefined;  },
): 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.

Parameters #

#path: PathLike

#opts: StatOptions & { bigint?: false | undefined; }

optional

Return Type #

Promise<Stats>

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

Overload 2

#lstat(path: PathLike,
opts: StatOptions & { bigint: true;  },
): Promise<BigIntStats>

Parameters #

#path: PathLike

#opts: StatOptions & { bigint: true; }

Return Type #

Promise<BigIntStats>

Overload 3

#lstat(path: PathLike,
opts?: StatOptions,
): Promise<Stats | BigIntStats>

Parameters #

#path: PathLike

#opts: StatOptions

optional

Return Type #

Promise<Stats | BigIntStats>