statfsSync - fs - Node

statfsSync - fs - Node documentation

function statfsSync

import { statfsSync } from "node:fs";



statfsSync(path: PathLike,
options?: StatFsOptions & { bigint?: false | undefined;  },
): StatsFs

Synchronous statfs(2). Returns information about the mounted file system which contains path.

In case of an error, the err.code will be one of Common System Errors.

Parameters



path: PathLike

A path to an existing file or directory on the file system to be queried.

optional



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

StatsFs



statfsSync(path: PathLike,
options: StatFsOptions & { bigint: true;  },
): BigIntStatsFs



path: PathLike



options: StatFsOptions & { bigint: true;  }

BigIntStatsFs



statfsSync(path: PathLike,
options?: StatFsOptions,
): StatsFs | BigIntStatsFs



path: PathLike

optional



options: StatFsOptions

StatsFs | BigIntStatsFs