lstat

function lstat

Usage

import { lstat } from "node:fs/promises";


        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.


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


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

Parameters

path: PathLike

optional

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

Return Type

Promise<Stats>

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

Parameters

path: PathLike

opts: StatOptions & { bigint: true;  }

Return Type

Promise<BigIntStats>

Parameters

path: PathLike

optional

opts: StatOptions

Return Type

Promise<Stats | BigIntStats>