Skip to main content
statfsSync - fs - Node documentation
function statfsSync

Usage in Deno

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; }

Return Type

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

Parameters

path: PathLike
options: StatFsOptions & { bigint: true; }

Return Type

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

Parameters

path: PathLike
optional
options: StatFsOptions

Return Type