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