Skip to main content
statfsSync - node__fs.d.ts - Node documentation
function statfsSync

Usage in Deno

```typescript import { statfsSync } from "node:node__fs.d.ts"; ```
statfsSync(
path: PathLike,
options?: StatFsOptions & { bigint?: false | undefined; },
): StatsFs
Synchronous [`statfs(2)`](http://man7.org/linux/man-pages/man2/statfs.2.html). 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