lstat - fs/promises - Node

function lstat

Usage in Deno

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.

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.



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

Parameters



path: PathLike



opts: StatOptions & { bigint: true;  }

Return Type

Promise<BigIntStats>



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

Parameters



path: PathLike

optional



opts: StatOptions

Return Type

Promise<Stats | BigIntStats>