stat - fs/promises - Node

stat - fs/promises - Node documentation

function stat

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



stat(path: PathLike,
opts?: StatOptions & { bigint?: false | undefined;  },
): Promise<Stats>

Parameters



path: PathLike

optional



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

Promise<Stats>

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



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



path: PathLike



opts: StatOptions & { bigint: true;  }

Promise<BigIntStats>



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



path: PathLike

optional



opts: StatOptions

Promise<Stats | BigIntStats>