Function statfs

statfs(path, callback): 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, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: StatsFs
      Returns void
Returns void
Since
v19.6.0, v18.15.0

See
- fs.statfs
- fs.promises.statfs
- Defined in src/fs/index.ts:304
statfs(path, options, callback): 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.
- options: undefined | StatFsOptions & {
  bigint?: false;
  }
- callback: ((err, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: StatsFs
      Returns void
Returns void
Since
v19.6.0, v18.15.0

See
- fs.statfs
- fs.promises.statfs
- Defined in src/fs/index.ts:304
statfs(path, options, callback): 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.
- options: StatFsOptions & {
  bigint: true;
  }
- callback: ((err, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: BigIntStatsFs
      Returns void
Returns void
Since
v19.6.0, v18.15.0

See
- fs.statfs
- fs.promises.statfs
- Defined in src/fs/index.ts:304
statfs(path, options, callback): 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.
- options: undefined | StatFsOptions
- callback: ((err, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: StatsFs | BigIntStatsFs
      Returns void
Returns void
Since
v19.6.0, v18.15.0

See
- fs.statfs
- fs.promises.statfs
- Defined in src/fs/index.ts:304
statfs(path, options?): Promise<StatsFs>
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.
- Optional options: StatFsOptions & {
  bigint?: false;
  }
Returns Promise<StatsFs>
Since
v19.6.0, v18.15.0

See
- fs.statfs
- fs.promises.statfs
- Defined in src/fs/index.ts:304
statfs(path, options): Promise<BigIntStatsFs>
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.
- options: StatFsOptions & {
  bigint: true;
  }
Returns Promise<BigIntStatsFs>
Since
v19.6.0, v18.15.0

See
- fs.statfs
- fs.promises.statfs
- Defined in src/fs/index.ts:304
statfs(path, options?): Promise<StatsFs | BigIntStatsFs>
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.
- Optional options: StatFsOptions
Returns Promise<StatsFs | BigIntStatsFs>
Since
v19.6.0, v18.15.0

See
- fs.statfs
- fs.promises.statfs
- Defined in src/fs/index.ts:304

Index

Methods

__promisify__

Methods

promisify

__promisify__(path, options?): Promise<StatsFs>
Asynchronous statfs(2) - Returns information about the mounted file system which contains path. The callback gets two arguments (err, stats) where stats is an <fs.StatFs> object.
Parameters
- path: PathLike
  A path to an existing file or directory on the file system to be queried.
- Optional options: StatFsOptions & {
  bigint?: false;
  }
Returns Promise<StatsFs>
- Defined in node_modules/.pnpm/@types+node@20.11.10/node_modules/@types/node/fs.d.ts:1215
__promisify__(path, options): Promise<BigIntStatsFs>
Parameters
- path: PathLike
- options: StatFsOptions & {
  bigint: true;
  }
Returns Promise<BigIntStatsFs>
- Defined in node_modules/.pnpm/@types+node@20.11.10/node_modules/@types/node/fs.d.ts:1221
__promisify__(path, options?): Promise<StatsFs | BigIntStatsFs>
Parameters
- path: PathLike
- Optional options: StatFsOptions
Returns Promise<StatsFs | BigIntStatsFs>
- Defined in node_modules/.pnpm/@types+node@20.11.10/node_modules/@types/node/fs.d.ts:1227

Function statfs

Parameters

path: PathLike

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: StatsFs

Returns void

Returns void

Since

See

Parameters

path: PathLike

options: undefined | StatFsOptions & { bigint?: false; }

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: StatsFs

Returns void

Returns void

Since

See

Parameters

path: PathLike

options: StatFsOptions & { bigint: true; }

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: BigIntStatsFs

Returns void

Returns void

Since

See

Parameters

path: PathLike

options: undefined | StatFsOptions

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: StatsFs | BigIntStatsFs

Returns void

Returns void

Since

See

Parameters

path: PathLike

Optional options: StatFsOptions & { bigint?: false; }

Returns Promise<StatsFs>

Since

See

Parameters

path: PathLike

options: StatFsOptions & { bigint: true; }

Returns Promise<BigIntStatsFs>

Since

See

Parameters

path: PathLike

Optional options: StatFsOptions

Returns Promise<StatsFs | BigIntStatsFs>

Since

See

Index

Methods

Methods

__promisify__

Parameters

path: PathLike

Optional options: StatFsOptions & { bigint?: false; }

Returns Promise<StatsFs>

Parameters

path: PathLike

options: StatFsOptions & { bigint: true; }

Returns Promise<BigIntStatsFs>

Parameters

path: PathLike

Optional options: StatFsOptions

Returns Promise<StatsFs | BigIntStatsFs>

Settings

Member Visibility

options: undefined | StatFsOptions & {
bigint?: false;
}

options: StatFsOptions & {
bigint: true;
}

`Optional` options: StatFsOptions & {
bigint?: false;
}

options: StatFsOptions & {
bigint: true;
}

`Optional` options: StatFsOptions

promisify

`Optional` options: StatFsOptions & {
bigint?: false;
}

options: StatFsOptions & {
bigint: true;
}

`Optional` options: StatFsOptions