未验证 提交 d93d9aee 编写于 作者: O openharmony_ci 提交者: Gitee

!5205 js-apis-fileio.md说明文档问题修改

Merge pull request !5205 from wangbo/master
...@@ -3,13 +3,7 @@ ...@@ -3,13 +3,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该模块提供文件存储相关的常用功能,向应用程序提供用于IO的JS接口,包括: 该模块提供文件存储管理能力,包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。
- 用于管理文件的基本文件接口
- 用于管理目录的基本目录接口
- 用于获取文件信息的统计接口
- 用于流式读写文件的流式接口
## 导入模块 ## 导入模块
...@@ -20,20 +14,11 @@ import fileio from '@ohos.fileio'; ...@@ -20,20 +14,11 @@ import fileio from '@ohos.fileio';
## 使用说明 ## 使用说明
使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱绝对路径,“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名”。 使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:
应用目录路径dir的获取方式及对应的接口用法请参考:[Context模块的接口getOrCreateLocalDir](js-apis-Context.md) ```js
通过上述接口获取到应用目录路径dir,文件名为“xxx.txt”,文件所在应用沙箱路径为: import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
```js let path = context.getFilesDir();
let path = dir + "/xxx.txt";
```
文件描述符fd:
```js
let fd = fileio.openSync(path);
``` ```
...@@ -1201,7 +1186,7 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void ...@@ -1201,7 +1186,7 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
| -------- | ------------------------- | ---- | ---------------- | | -------- | ------------------------- | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 | | fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 | | len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 | | callback | AsyncCallback<void> | 是 | 回调函数,本调用无返回值。 |
**示例:** **示例:**
```js ```js
...@@ -1273,7 +1258,7 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void ...@@ -1273,7 +1258,7 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void
| -------- | ------------------------- | ---- | -------------------------------- | | -------- | ------------------------- | ---- | -------------------------------- |
| path | string | 是 | 待截断文件的应用沙箱路径。 | | path | string | 是 | 待截断文件的应用沙箱路径。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 | | len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 | | callback | AsyncCallback<void> | 是 | 回调函数,本调用无返回值。 |
**示例:** **示例:**
```js ```js
...@@ -1352,8 +1337,8 @@ readText(filePath: string, options: { ...@@ -1352,8 +1337,8 @@ readText(filePath: string, options: {
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| filePath | string | 是 | 待读取文件的应用沙箱路径。 | | filePath | string | 是 | 待读取文件的应用沙箱路径。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,当数据是&nbsp;string&nbsp;类型时有效,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步通过文本方式读取文件之后的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数,返回读取文件的内容。 |
**示例:** **示例:**
```js ```js
...@@ -1403,12 +1388,12 @@ lstat(path: string): Promise&lt;Stat&gt; ...@@ -1403,12 +1388,12 @@ lstat(path: string): Promise&lt;Stat&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------- | | ------ | ------ | ---- | -------------------------------------- |
| path | string | 是 | 目标文件的应用沙箱路径,指向链接。 | | path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------- | ---------- | | ---------------------------- | ---------- |
| Promise&lt;[Stat](#stat)&gt; | Promise对象。返回表示文件状态的具体信息。 | | Promise&lt;[Stat](#stat)&gt; | promise对象,返回文件对象,表示文件的具体信息,详情见stat。 |
**示例:** **示例:**
```js ```js
...@@ -1431,8 +1416,8 @@ lstat(path:string, callback:AsyncCallback&lt;Stat&gt;): void ...@@ -1431,8 +1416,8 @@ lstat(path:string, callback:AsyncCallback&lt;Stat&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------- | ---- | -------------------------------------- |
| path | string | 是 | 目标文件的应用沙箱路径,指向链接。 | | path | string | 是 | 目标文件的应用沙箱路径。 |
| callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 异步获取链接信息之后的回调。 | | callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 回调函数,返回文件的具体信息。 |
**示例:** **示例:**
```js ```js
...@@ -1453,7 +1438,7 @@ lstatSync(path:string): Stat ...@@ -1453,7 +1438,7 @@ lstatSync(path:string): Stat
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------- | | ------ | ------ | ---- | -------------------------------------- |
| path | string | 是 | 目标文件的应用沙箱路径,指向链接。 | | path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
......
...@@ -63,13 +63,19 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback&lt;FileInfo[]&gt;) ...@@ -63,13 +63,19 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback&lt;FileInfo[]&gt;)
- 示例 - 示例
```js ```js
filemanager.getRoot((err, fileInfo) => { let option = {
"dev":{
name:"",
}
};
filemanager.getRoot(option,(err, fileInfo)=>{
if(Array.isArray(fileInfo)) { if(Array.isArray(fileInfo)) {
for (var i = 0; i < fileInfo.length; i++) { for (var i = 0; i < fileInfo.length; i++) {
console.log("file:"+JSON.stringify(fileInfo)); console.log("file:"+JSON.stringify(fileInfo));
} }
} }
}); });
``` ```
## filemanager.listFile ## filemanager.listFile
...@@ -105,7 +111,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num ...@@ -105,7 +111,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
```js ```js
// 获取目录下所有文件 // 获取目录下所有文件
// 通过listFile、getRoot获取的文件uri // 通过listFile、getRoot获取的文件uri
let media_path = file.uri let media_path = file.path
filemanager.listFile(media_path, "file") filemanager.listFile(media_path, "file")
.then((fileInfo) => { .then((fileInfo) => {
if(Array.isArray(fileInfo)) { if(Array.isArray(fileInfo)) {
...@@ -114,6 +120,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num ...@@ -114,6 +120,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
} }
} }
}).catch((err) => { }).catch((err) => {
console.log(err) console.log(err)
}); });
``` ```
...@@ -145,14 +154,30 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num ...@@ -145,14 +154,30 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
- 示例 - 示例
```js ```js
// 通过listFile、getRoot获取的文件uri // 通过listFile、getRoot获取的文件path
let media_path = file.uri let fileInfos = await filemanager.getRoot();
filemanager.listFile(media_path, "file", (err, fileInfo) => { let media_path = "";
if(Array.isArray(fileInfo)) { for (let i = 0; i < fileInfos.length; i++) {
for (var i = 0; i < fileInfo.length; i++) { if (fileInfos[i].name == "image_album") {
console.log("file:"+JSON.stringify(fileInfo)); media_path = fileInfos[i].path;
} } else if (fileInfos[i].name == "audio_album") {
} media_path = fileInfos[i].path;
} else if (fileInfos[i].name == "video_album") {
media_path = fileInfos[i].path;
} else if (fileInfos[i].name == "file_folder") {
media_path = fileInfos[i].path;
}
}
filemanager.listFile(media_path, "file")
.then((fileInfo) => {
if(Array.isArray(fileInfo)) {
for (var i = 0; i < fileInfo.length; i++) {
console.log("file:"+JSON.stringify(fileInfo));
}
}
}).catch((err) => {
console.log(err)
}); });
``` ```
...@@ -230,7 +255,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac ...@@ -230,7 +255,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
```js ```js
// 创建文件,返回文件uri // 创建文件,返回文件uri
// 通过listFile、getRoot获取的文件uri // 通过listFile、getRoot获取的文件uri
let media_path = file.uri let media_path = file.path
// 待保存文件的后缀 // 待保存文件的后缀
let name = "xxx.jpg" let name = "xxx.jpg"
filemanager.createFile(media_path, name, (err, uri) => { filemanager.createFile(media_path, name, (err, uri) => {
......
...@@ -10,19 +10,6 @@ ...@@ -10,19 +10,6 @@
```js ```js
import statfs from '@ohos.statfs'; import statfs from '@ohos.statfs';
``` ```
## 使用说明
使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)
“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名”
通过上述接口获取到应用目录路径dir,以文件名“xxx.txt”为例,文件所在应用沙箱路径为:
```js
let path = dir + "xxx.txt";
```
## statfs.getFreeBytes ## statfs.getFreeBytes
getFreeBytes(path:string):Promise&lt;number&gt; getFreeBytes(path:string):Promise&lt;number&gt;
...@@ -72,8 +59,12 @@ getFreeBytes(path:string, callback:AsyncCallback&lt;number&gt;): void ...@@ -72,8 +59,12 @@ getFreeBytes(path:string, callback:AsyncCallback&lt;number&gt;): void
- 示例: - 示例:
```js ```js
statfs.getFreeBytes(path, function(err, number){ import featureAbility from '@ohos.ability.featureAbility';
console.info("getFreeBytes callback successfully:"+ number); let context = featureAbility.getContext();
context.getFilesDir().then(function (path) {
statfs.getFreeBytes(path, function(err, number){
console.info("getFreeBytes callback successfully:"+ number);
});
}); });
``` ```
...@@ -126,8 +117,12 @@ getTotalBytes(path: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -126,8 +117,12 @@ getTotalBytes(path: string, callback: AsyncCallback&lt;number&gt;): void
- 示例: - 示例:
```js ```js
statfs.getTotalBytes(path, function(err, number){ import featureAbility from '@ohos.ability.featureAbility';
console.info("getTotalBytes callback successfully:"+ number); let context = featureAbility.getContext();
context.getFilesDir().then(function (path) {
statfs.getTotalBytes(path, function(err, number){
console.info("getTotalBytes callback successfully:"+ number);
});
}); });
``` ```
...@@ -154,7 +154,7 @@ export default { ...@@ -154,7 +154,7 @@ export default {
file.list({ file.list({
uri: 'internal://app/pic', uri: 'internal://app/pic',
success: function(data) { success: function(data) {
console.log(data.fileList); console.log(JSON.stringify(data.fileList));
}, },
fail: function(data, code) { fail: function(data, code) {
console.error('call fail callback fail, code: ' + code + ', data: ' + data); console.error('call fail callback fail, code: ' + code + ', data: ' + data);
......
...@@ -54,7 +54,7 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void ...@@ -54,7 +54,7 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
```js ```js
let uuid = ""; let uuid = "";
volumemanager.getAllVolumes(uuid, function(error, volumes){ volumemanager.getAllVolumes(function(error, volumes){
// do something // do something
}); });
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册