From 49a4fd41c05a654573de2d8c62af12706c1892b3 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Wed, 17 Nov 2021 17:33:00 +0800 Subject: [PATCH 1/3] =?UTF-8?q?statfs=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E6=8F=90=E4=BA=A4zhangxingxia050@chinasoftinc.com?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: zhangxingxia --- zh-cn/application-dev/js-reference/statfs.md | 191 +++++++++++++++++++ 1 file changed, 191 insertions(+) create mode 100644 zh-cn/application-dev/js-reference/statfs.md diff --git a/zh-cn/application-dev/js-reference/statfs.md b/zh-cn/application-dev/js-reference/statfs.md new file mode 100644 index 00000000000..410f753d4af --- /dev/null +++ b/zh-cn/application-dev/js-reference/statfs.md @@ -0,0 +1,191 @@ +# Statfs管理 + + + +## 支持设备 + +| 手机 | 平板 | 智慧屏 | 智能穿戴 | +| ---- | ---- | ------ | -------- | +| 支持 | 支持 | 支持 | 支持 | + + + +## 导入模块 + +```js +import StatfsNExporter from '@ohos.statfs' +``` + + + +## 权限列表 + +无 + + + +## getFrsize(path:string): number + +获取非root用户空闲字节数。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + +- 返回值： + + | 类型 | 说明 | + | :----- | :----------------------- | + | number | 返回非root用户空闲字节数 | + +- 示例： + + ```js + let num = StatfsNExporter.getFrsize(path); + ``` + + + +## getBsize(path: string): number + +获取经过优化的传输块大小。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + +- 返回值： + + | 类型 | 说明 | + | :----- | :----------------------- | + | number | 返回经过优化的传输块大小 | + +- 示例： + + ```js + let num = StatfsNExporter.getBsize(path); + ``` + + + +## getBavail(path:string):number + +获取非root用户可使用的块数。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + +- 返回值： + + | 类型 | 说明 | + | ------ | -------------------------- | + | number | 返回非root用户可使用的块数 | + +- 示例： + + ```js + let num = StatfsNExporter.getBavail(path); + ``` + + + +## getBlocks(path:string):number + +获取文件系统数据块总数。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + +- 返回值： + + | 类型 | 说明 | + | ------ | ---------------------- | + | number | 返回文件系统数据块总数 | + +- 示例： + + ```js + let num = StatfsNExporter.getBlocks(path); + ``` + + + +## getBfree(path:string):number + +获取可用块数。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + +- 返回值： + + | 类型 | 说明 | + | ------ | ------------ | + | number | 返回可用块数 | + +- 示例： + + ```js + let num = StatfsNExporter.getBfree(path); + ``` + + + +## getFreeBytes(path:string): number + +获取总的空闲字节数。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + +- 返回值： + + | 类型 | 说明 | + | ------ | ------------------ | + | number | 返回总的空闲字节数 | + +- 示例： + + ```js + let num = StatfsNExporter.getFreeBytes(path); + ``` + + + +## getTotalBytes(path:string):number + +获取总的字节数。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + +- 返回值： + + | 类型 | 说明 | + | ------ | ------------------ | + | number | 返回获取总的字节数 | + +- 示例： + + ```js + let num = StatfsNExporter.getTotalBytes(path); + ``` -- Gitee From 5b8ec4b802f13306e1e773122a476f13a214192e Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Fri, 19 Nov 2021 16:01:50 +0800 Subject: [PATCH 2/3] =?UTF-8?q?statfs=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E6=8F=90=E4=BA=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: zhangxingxia --- zh-cn/application-dev/js-reference/statfs.md | 152 +++++-------------- 1 file changed, 34 insertions(+), 118 deletions(-) diff --git a/zh-cn/application-dev/js-reference/statfs.md b/zh-cn/application-dev/js-reference/statfs.md index 410f753d4af..18076cfc217 100644 --- a/zh-cn/application-dev/js-reference/statfs.md +++ b/zh-cn/application-dev/js-reference/statfs.md @@ -13,7 +13,7 @@ ## 导入模块 ```js -import StatfsNExporter from '@ohos.statfs' +import statfs from '@ohos.statfs' ``` @@ -22,170 +22,86 @@ import StatfsNExporter from '@ohos.statfs' 无 +## getFreeBytes(path:string):Promise - -## getFrsize(path:string): number - -获取非root用户空闲字节数。 +异步方法获取空闲字节数，以Promise形式返回结果。 - 参数： | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------------------- | | path | string | 是 | 需要查询的文件系统的文件路径 | - -- 返回值： - - | 类型 | 说明 | - | :----- | :----------------------- | - | number | 返回非root用户空闲字节数 | - -- 示例： - - ```js - let num = StatfsNExporter.getFrsize(path); - ``` - - -## getBsize(path: string): number - -获取经过优化的传输块大小。 - -- 参数： - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - - 返回值： - | 类型 | 说明 | - | :----- | :----------------------- | - | number | 返回经过优化的传输块大小 | + | 类型 | 说明 | + | --------------- | -------------- | + | Promise | 返回空闲字节数 | - 示例： ```js - let num = StatfsNExporter.getBsize(path); + let num = await statfs.getFreeBytes(path); ``` +## getFreeBytes(path:string, callback:AsyncCallback): void - -## getBavail(path:string):number - -获取非root用户可使用的块数。 +异步方法获取空闲字节数，使用callback形式返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - -- 返回值： - - | 类型 | 说明 | - | ------ | -------------------------- | - | number | 返回非root用户可使用的块数 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback | 是 | 异步获取空闲字节数之后的回调 | - 示例： ```js - let num = StatfsNExporter.getBavail(path); + statfs.getFreeBytes(path,function(err,number){ + //do something + }); ``` +## getTotalBytes(path:string):Promise - -## getBlocks(path:string):number - -获取文件系统数据块总数。 +异步方法获取总字节数，以Promise形式返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - -- 返回值： - - | 类型 | 说明 | - | ------ | ---------------------- | - | number | 返回文件系统数据块总数 | - -- 示例： - - ```js - let num = StatfsNExporter.getBlocks(path); - ``` - - - -## getBfree(path:string):number - -获取可用块数。 - -- 参数： - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | + | 参数 | 类型 | 必填 | 说明 | + | ---- | ------ | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | - 返回值： - | 类型 | 说明 | - | ------ | ------------ | - | number | 返回可用块数 | + | 类型 | 说明 | + | --------------- | ------------ | + | Promise | 返回总字节数 | - 示例： ```js - let num = StatfsNExporter.getBfree(path); + let num = await statfs.getTotalBytes(path); ``` +## getTotalBytes(path:string, callback:AsyncCallback): void - -## getFreeBytes(path:string): number - -获取总的空闲字节数。 +异步方法获取总的字节数，使用callback形式返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - -- 返回值： - - | 类型 | 说明 | - | ------ | ------------------ | - | number | 返回总的空闲字节数 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback | 是 | 异步获取总字节数之后的回调 | - 示例： ```js - let num = StatfsNExporter.getFreeBytes(path); + statfs.getTotalBytes(path,function(err,number){ + //do something + }); ``` - -## getTotalBytes(path:string):number - -获取总的字节数。 - -- 参数： - - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - -- 返回值： - - | 类型 | 说明 | - | ------ | ------------------ | - | number | 返回获取总的字节数 | - -- 示例： - - ```js - let num = StatfsNExporter.getTotalBytes(path); - ``` -- Gitee From a5067830bdda5158df97491c036454cd7b1ddc3d Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Fri, 19 Nov 2021 16:06:12 +0800 Subject: [PATCH 3/3] =?UTF-8?q?statfs=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E6=8F=90=E4=BA=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: zhangxingxia --- zh-cn/application-dev/js-reference/statfs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/application-dev/js-reference/statfs.md b/zh-cn/application-dev/js-reference/statfs.md index 18076cfc217..973bcbfd5e5 100644 --- a/zh-cn/application-dev/js-reference/statfs.md +++ b/zh-cn/application-dev/js-reference/statfs.md @@ -87,7 +87,7 @@ import statfs from '@ohos.statfs' ## getTotalBytes(path:string, callback:AsyncCallback): void -异步方法获取总的字节数，使用callback形式返回结果。 +异步方法获取总字节数，使用callback形式返回结果。 - 参数： -- Gitee