Skip to main content

statfs

function statfs
Jump to headingstatfs(
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 Jump to heading

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

Jump to headingcallback: (
err: ErrnoException | null,
stats: StatsFs,
) => void

Return Type Jump to heading

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

Parameters Jump to heading

Jump to headingoptions: (StatFsOptions & { bigint?: false | undefined; }) | undefined
Jump to headingcallback: (
err: ErrnoException | null,
stats: StatsFs,
) => void

Return Type Jump to heading

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

Parameters Jump to heading

Jump to headingoptions: StatFsOptions & { bigint: true; }
Jump to headingcallback: (
err: ErrnoException | null,
) => void

Return Type Jump to heading

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

Parameters Jump to heading

Jump to headingoptions: StatFsOptions | undefined
Jump to headingcallback: (
err: ErrnoException | null,
) => void

Return Type Jump to heading

void
Back to top