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