• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.statfs (statfs)
2
3该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。
4
5> **说明：**
6> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
7> - 本模块从API version 9开始废弃，建议使用[@ohos.file.statvfs](js-apis-file-statvfs.md)替代。
8
9## 导入模块
10
11```ts
12import statfs from '@ohos.statfs';
13```
14## statfs.getFreeBytes
15
16getFreeBytes(path:string):Promise<number>
17
18异步方法获取指定文件系统空闲字节数，以Promise形式返回结果。
19
20**系统能力**：SystemCapability.FileManagement.File.FileIO
21
22**参数：**
23
24  | 参数名 | 类型   | 必填 | 说明                         |
25  | ------ | ------ | ---- | ---------------------------- |
26  | path   | string | 是   | 需要查询的文件系统的文件路径 |
27
28**返回值：**
29
30  | 类型                  | 说明           |
31  | --------------------- | -------------- |
32  | Promise<number> | 返回空闲字节数 |
33
34**示例：**
35
36  ```ts
37  import { BusinessError } from '@ohos.base';
38  let path = "/dev";
39  statfs.getFreeBytes(path).then((number: number) => {
40    console.info("getFreeBytes promise successfully:" + number);
41  }).catch((err: BusinessError) => {
42    console.info("getFreeBytes failed with error:" + JSON.stringify(err));
43  });
44  ```
45
46## statfs.getFreeBytes
47
48getFreeBytes(path:string, callback:AsyncCallback<number>): void
49
50异步方法获取指定文件系统空闲字节数，使用callback形式返回结果。
51
52**系统能力**：SystemCapability.FileManagement.File.FileIO
53
54**参数：**
55
56  | 参数名   | 类型                        | 必填 | 说明                         |
57  | -------- | --------------------------- | ---- | ---------------------------- |
58  | path     | string                      | 是   | 需要查询的文件系统的文件路径 |
59  | callback | AsyncCallback<number> | 是   | 异步获取空闲字节数之后的回调 |
60
61**示例：**
62
63  ```js
64  import featureAbility from '@ohos.ability.featureAbility';
65  let context = featureAbility.getContext();
66  context.getFilesDir().then(function (path) {
67      statfs.getFreeBytes(path, function (err, number) {
68          console.info("getFreeBytes callback successfully:" + number);
69      });
70  });
71  ```
72
73## statfs.getTotalBytes
74
75getTotalBytes(path: string): Promise<number>
76
77异步方法获取指定文件系统总字节数，以Promise形式返回结果。
78
79**系统能力**：SystemCapability.FileManagement.File.FileIO
80
81**参数：**
82
83  | 参数名 | 类型   | 必填 | 说明                         |
84  | ---- | ------ | ---- | ---------------------------- |
85  | path | string | 是   | 需要查询的文件系统的文件路径 |
86
87**返回值：**
88
89  | 类型                  | 说明         |
90  | --------------------- | ------------ |
91  | Promise<number> | 返回总字节数 |
92
93**示例：**
94
95  ```ts
96  import { BusinessError } from '@ohos.base';
97  let path = "/dev";
98  statfs.getTotalBytes(path).then((number: number) => {
99    console.info("getTotalBytes promise successfully:" + number);
100  }).catch((err: BusinessError) => {
101    console.info("getTotalBytes failed with error:" + JSON.stringify(err));
102  });
103  ```
104
105## statfs.getTotalBytes
106
107getTotalBytes(path: string, callback: AsyncCallback<number>): void
108
109异步方法获取指定文件系统总字节数，使用callback形式返回结果。
110
111**系统能力**：SystemCapability.FileManagement.File.FileIO
112
113**参数：**
114
115  | 参数名   | 类型                        | 必填 | 说明                         |
116  | -------- | --------------------------- | ---- | ---------------------------- |
117  | path     | string                      | 是   | 需要查询的文件系统的文件路径 |
118  | callback | AsyncCallback<number> | 是   | 异步获取总字节数之后的回调   |
119
120**示例：**
121
122  ```js
123  import featureAbility from '@ohos.ability.featureAbility';
124  let context = featureAbility.getContext();
125  context.getFilesDir().then(function (path) {
126      statfs.getTotalBytes(path, function(err, number) {
127          console.info("getTotalBytes callback successfully:" + number);
128      });
129  });
130  ```
131
132