statfs - fs/promises - Node

statfs - fs/promises - Node documentation

function statfs

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



statfs(path: PathLike,
opts?: StatFsOptions & { bigint?: false | undefined;  },
): Promise<StatsFs>

Parameters



path: PathLike

optional



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

Promise<StatsFs>

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



statfs(path: PathLike,
opts: StatFsOptions & { bigint: true;  },
): Promise<BigIntStatsFs>



path: PathLike



opts: StatFsOptions & { bigint: true;  }

Promise<BigIntStatsFs>



statfs(path: PathLike,
opts?: StatFsOptions,
): Promise<StatsFs | BigIntStatsFs>



path: PathLike

optional



opts: StatFsOptions

Promise<StatsFs | BigIntStatsFs>