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

Usage in Deno

import { statfs } from "node:fs";
statfs(
path: PathLike,
callback: (
err: ErrnoException | null,
stats: StatsFs,
) => void,
): void

Asynchronous statfs(2). Returns information about the mounted file system which contains path. The callback gets two arguments (err, stats) where statsis an fs.StatFs object.

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.

callback: (
err: ErrnoException | null,
stats: StatsFs,
) => void

Return Type

void
statfs(
path: PathLike,
options: (StatFsOptions & { bigint?: false | undefined; }) | undefined,
callback: (
err: ErrnoException | null,
stats: StatsFs,
) => void,
): void

Parameters

path: PathLike
options: (StatFsOptions & { bigint?: false | undefined; }) | undefined
callback: (
err: ErrnoException | null,
stats: StatsFs,
) => void

Return Type

void
statfs(
path: PathLike,
options: StatFsOptions & { bigint: true; },
callback: (
err: ErrnoException | null,
) => void,
): void

Parameters

path: PathLike
options: StatFsOptions & { bigint: true; }
callback: (
err: ErrnoException | null,
) => void

Return Type

void
statfs(
path: PathLike,
options: StatFsOptions | undefined,
callback: (
err: ErrnoException | null,
) => void,
): void

Parameters

path: PathLike
options: StatFsOptions | undefined
callback: (
err: ErrnoException | null,
) => void

Return Type

void