Function lstat

lstat(path: PathLike, 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.

Since
v10.0.0

Returns
Fulfills with the {fs.Stats} object for the given symbolic link path.
Parameters
- path: PathLike
- Optional opts: StatOptions & {
  bigint?: false;
  }
Returns Promise<Stats>
- Defined in node_modules/@types/node/fs/promises.d.ts:721
lstat(path: PathLike, opts: StatOptions & {
bigint: true;
}): Promise<BigIntStats>
Parameters
- path: PathLike
- opts: StatOptions & {
  bigint: true;
  }
Returns Promise<BigIntStats>
- Defined in node_modules/@types/node/fs/promises.d.ts:727
lstat(path: PathLike, opts?: StatOptions): Promise<Stats | BigIntStats>
Parameters
- path: PathLike
- Optional opts: StatOptions
Returns Promise<Stats | BigIntStats>
- Defined in node_modules/@types/node/fs/promises.d.ts:733

Generated using TypeDoc