DocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
Nstatfs
Bun

namespace

fs.statfs

function statfs(
path: PathLike,
callback: (err: null | ErrnoException, 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.

@param path

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

function statfs(
path: PathLike,
options: undefined | StatFsOptions & { bigint: false },
callback: (err: null | ErrnoException, 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.

@param path

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

function statfs(
path: PathLike,
options: StatFsOptions & { bigint: true },
callback: (err: null | ErrnoException, stats: BigIntStatsFs) => 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.

@param path

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

function statfs(
path: PathLike,
options: undefined | StatFsOptions,
callback: (err: null | ErrnoException, stats: StatsFs | BigIntStatsFs) => 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.

@param path

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

namespace statfs