From 26c72f7d17c3c7d81c20227855729f71cbd501ff Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Wed, 29 Dec 2021 17:48:23 +0800 Subject: [PATCH 1/3] add statfs api Signed-off-by: zhangxingxia --- .../reference/apis/js-apis-statfs.md | 70 ++++++++++++------- 1 file changed, 44 insertions(+), 26 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index cf328128686..0f866d8320c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -1,20 +1,32 @@ -# Statfs管理 +# statfs ## 导入模块 -```js +``` import statfs from '@ohos.statfs' ``` +## 使用说明 + +使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 +“文件/目录绝对路径”=“应用目录路径”+“文件/目录名” + +通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为： + +``` +let path = dir + "xxx.txt" +``` ## 权限列表 无 -## statfs.getFreeBytes(path:string):Promise +## statfs.getFreeBytes + +getFreeBytes(path:string):Promise\ 异步方法获取指定文件系统空闲字节数，以Promise形式返回结果。 @@ -26,36 +38,40 @@ import statfs from '@ohos.statfs' - 返回值： - | 类型 | 说明 | - | --------------- | -------------- | - | Promise | 返回空闲字节数 | + | 类型 | 说明 | + | ----------------- | -------------- | + | Promise\ | 返回空闲字节数 | - 示例： - ```js + ``` let num = await statfs.getFreeBytes(path); ``` -## statfs.getFreeBytes(path:string, callback:AsyncCallback): void +## statfs.getFreeBytes + +getFreeBytes(path:string, callback:AsyncCallback\): void 异步方法获取指定文件系统空闲字节数，使用callback形式返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------- | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - | callback | AsyncCallback | 是 | 异步获取空闲字节数之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback\ | 是 | 异步获取空闲字节数之后的回调 | - 示例： - ```js - statfs.getFreeBytes(path,function(err,number){ + ``` + statfs.getFreeBytes(path,function(err, number){ //do something }); ``` -## statfs.getTotalBytes(path:string):Promise +## statfs.getTotalBytes + +getTotalBytes.(path:string):Promise\ 异步方法获取指定文件系统总字节数，以Promise形式返回结果。 @@ -67,31 +83,33 @@ import statfs from '@ohos.statfs' - 返回值： - | 类型 | 说明 | - | --------------- | ------------ | - | Promise | 返回总字节数 | + | 类型 | 说明 | + | ----------------- | ------------ | + | Promise\ | 返回总字节数 | - 示例： - ```js + ``` let num = await statfs.getTotalBytes(path); ``` -## statfs.getTotalBytes(path:string, callback:AsyncCallback): void +## statfs.getTotalBytes + +getTotalBytes(path:string, callback:AsyncCallback\): void 异步方法获取指定文件系统总字节数，使用callback形式返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------- | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - | callback | AsyncCallback | 是 | 异步获取总字节数之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback\ | 是 | 异步获取总字节数之后的回调 | - 示例： - ```js - statfs.getTotalBytes(path,function(err,number){ + ``` + statfs.getTotalBytes(path,function(err, number){ //do something }); ``` -- Gitee From b183de11681e5a013fd0024959a2191f0cf0a159 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Wed, 29 Dec 2021 18:09:10 +0800 Subject: [PATCH 2/3] add statfs api Signed-off-by: zhangxingxia --- .../reference/apis/js-apis-statfs.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index 0f866d8320c..609c98eda54 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -26,7 +26,7 @@ let path = dir + "xxx.txt" ## statfs.getFreeBytes -getFreeBytes(path:string):Promise\ +getFreeBytes(path:string):Promise<number> 异步方法获取指定文件系统空闲字节数，以Promise形式返回结果。 @@ -38,9 +38,9 @@ getFreeBytes(path:string):Promise\ - 返回值： - | 类型 | 说明 | - | ----------------- | -------------- | - | Promise\ | 返回空闲字节数 | + | 类型 | 说明 | + | --------------------- | -------------- | + | Promise<number> | 返回空闲字节数 | - 示例： @@ -50,28 +50,28 @@ getFreeBytes(path:string):Promise\ ## statfs.getFreeBytes -getFreeBytes(path:string, callback:AsyncCallback\): void +getFreeBytes(path:string, callback:AsyncCallback<number>): void 异步方法获取指定文件系统空闲字节数，使用callback形式返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------- | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - | callback | AsyncCallback\ | 是 | 异步获取空闲字节数之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback<void> | 是 | 异步获取空闲字节数之后的回调 | - 示例： ``` - statfs.getFreeBytes(path,function(err, number){ + statfs.getFreeBytes(path,function(err,number){ //do something }); ``` ## statfs.getTotalBytes -getTotalBytes.(path:string):Promise\ +getTotalBytes.(path:string):Promise<number> 异步方法获取指定文件系统总字节数，以Promise形式返回结果。 @@ -83,9 +83,9 @@ getTotalBytes.(path:string):Promise\ - 返回值： - | 类型 | 说明 | - | ----------------- | ------------ | - | Promise\ | 返回总字节数 | + | 类型 | 说明 | + | --------------------- | ------------ | + | Promise<number> | 返回总字节数 | - 示例： @@ -95,16 +95,16 @@ getTotalBytes.(path:string):Promise\ ## statfs.getTotalBytes -getTotalBytes(path:string, callback:AsyncCallback\): void +getTotalBytes(path:string, callback:AsyncCallback<number>): void 异步方法获取指定文件系统总字节数，使用callback形式返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------- | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - | callback | AsyncCallback\ | 是 | 异步获取总字节数之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback<void> | 是 | 异步获取总字节数之后的回调 | - 示例： -- Gitee From 2874008925d62c0a2030bbda40e1a96cfec044ac Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Thu, 30 Dec 2021 17:41:01 +0800 Subject: [PATCH 3/3] update statfs apis Signed-off-by: zhangxingxia --- zh-cn/application-dev/reference/apis/js-apis-statfs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index 609c98eda54..c6575cb730d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -64,7 +64,7 @@ getFreeBytes(path:string, callback:AsyncCallback<number>): void - 示例： ``` - statfs.getFreeBytes(path,function(err,number){ + statfs.getFreeBytes(path, function(err, number){ //do something }); ``` @@ -109,7 +109,7 @@ getTotalBytes(path:string, callback:AsyncCallback<number>): void - 示例： ``` - statfs.getTotalBytes(path,function(err, number){ + statfs.getTotalBytes(path, function(err, number){ //do something }); ``` -- Gitee