Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d93d9aee
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
d93d9aee
编写于
6月 15, 2022
作者:
O
openharmony_ci
提交者:
Gitee
6月 15, 2022
浏览文件
操作
浏览文件
下载
差异文件
!5205 js-apis-fileio.md说明文档问题修改
Merge pull request !5205 from wangbo/master
上级
73605714
69f063ff
变更
5
显示空白变更内容
内联
并排
Showing
5 changed file
with
66 addition
and
61 deletion
+66
-61
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+15
-30
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
+37
-12
zh-cn/application-dev/reference/apis/js-apis-statfs.md
zh-cn/application-dev/reference/apis/js-apis-statfs.md
+12
-17
zh-cn/application-dev/reference/apis/js-apis-system-file.md
zh-cn/application-dev/reference/apis/js-apis-system-file.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
...n/application-dev/reference/apis/js-apis-volumemanager.md
+1
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
d93d9aee
...
...
@@ -3,13 +3,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该模块提供文件存储相关的常用功能,向应用程序提供用于IO的JS接口,包括:
-
用于管理文件的基本文件接口
-
用于管理目录的基本目录接口
-
用于获取文件信息的统计接口
-
用于流式读写文件的流式接口
该模块提供文件存储管理能力,包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。
## 导入模块
...
...
@@ -20,20 +14,11 @@ import fileio from '@ohos.fileio';
## 使用说明
使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱绝对路径,“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名”。
应用目录路径dir的获取方式及对应的接口用法请参考:
[
Context模块的接口getOrCreateLocalDir
](
js-apis-Context.md
)
。
通过上述接口获取到应用目录路径dir,文件名为“xxx.txt”,文件所在应用沙箱路径为:
```
js
let
path
=
dir
+
"
/xxx.txt
"
;
```
文件描述符fd:
```
js
let
fd
=
fileio
.
openSync
(
path
);
使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
let
path
=
context
.
getFilesDir
();
```
...
...
@@ -1201,7 +1186,7 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
| -------- | ------------------------- | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是 |
异步截断文件的信息之后的回调
。 |
| callback | AsyncCallback
<
void
>
| 是 |
回调函数,本调用无返回值
。 |
**示例:**
```
js
...
...
@@ -1273,7 +1258,7 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void
| -------- | ------------------------- | ---- | -------------------------------- |
| path | string | 是 | 待截断文件的应用沙箱路径。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是 |
异步截断文件的信息之后的回调
。 |
| callback | AsyncCallback
<
void
>
| 是 |
回调函数,本调用无返回值
。 |
**示例:**
```
js
...
...
@@ -1352,8 +1337,8 @@ readText(filePath: string, options: {
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| filePath | string | 是 | 待读取文件的应用沙箱路径。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,
当数据是
string
类型时有效,
表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
| callback | AsyncCallback
<
string
>
| 是 |
异步通过文本方式读取文件之后的回调
。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
| callback | AsyncCallback
<
string
>
| 是 |
回调函数,返回读取文件的内容
。 |
**示例:**
```
js
...
...
@@ -1403,12 +1388,12 @@ lstat(path: string): Promise<Stat>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------- |
| path | string | 是 | 目标文件的应用沙箱路径
,指向链接
。 |
| path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
|
Promise对象。返回表示文件状态的具体信息
。 |
| Promise
<
[Stat](#stat)
>
|
promise对象,返回文件对象,表示文件的具体信息,详情见stat
。 |
**示例:**
```
js
...
...
@@ -1431,8 +1416,8 @@ lstat(path:string, callback:AsyncCallback<Stat>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | -------------------------------------- |
| path | string | 是 | 目标文件的应用沙箱路径
,指向链接
。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 |
异步获取链接信息之后的回调
。 |
| path | string | 是 | 目标文件的应用沙箱路径。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 |
回调函数,返回文件的具体信息
。 |
**示例:**
```
js
...
...
@@ -1453,7 +1438,7 @@ lstatSync(path:string): Stat
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------- |
| path | string | 是 | 目标文件的应用沙箱路径
,指向链接
。 |
| path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
浏览文件 @
d93d9aee
...
...
@@ -63,13 +63,19 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>)
-
示例
```
js
filemanager
.
getRoot
((
err
,
fileInfo
)
=>
{
let
option
=
{
"
dev
"
:{
name
:
""
,
}
};
filemanager
.
getRoot
(
option
,(
err
,
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
console
.
log
(
"
file:
"
+
JSON
.
stringify
(
fileInfo
));
}
}
});
```
## filemanager.listFile
...
...
@@ -105,7 +111,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
```
js
// 获取目录下所有文件
// 通过listFile、getRoot获取的文件uri
let
media_path
=
file
.
uri
let
media_path
=
file
.
path
filemanager
.
listFile
(
media_path
,
"
file
"
)
.
then
((
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
...
...
@@ -114,6 +120,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
}
}
}).
catch
((
err
)
=>
{
console
.
log
(
err
)
});
```
...
...
@@ -145,14 +154,30 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
-
示例
```
js
// 通过listFile、getRoot获取的文件uri
let
media_path
=
file
.
uri
filemanager
.
listFile
(
media_path
,
"
file
"
,
(
err
,
fileInfo
)
=>
{
// 通过listFile、getRoot获取的文件path
let
fileInfos
=
await
filemanager
.
getRoot
();
let
media_path
=
""
;
for
(
let
i
=
0
;
i
<
fileInfos
.
length
;
i
++
)
{
if
(
fileInfos
[
i
].
name
==
"
image_album
"
)
{
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
```
js
// 创建文件,返回文件uri
// 通过listFile、getRoot获取的文件uri
let
media_path
=
file
.
uri
let
media_path
=
file
.
path
// 待保存文件的后缀
let
name
=
"
xxx.jpg
"
filemanager
.
createFile
(
media_path
,
name
,
(
err
,
uri
)
=>
{
...
...
zh-cn/application-dev/reference/apis/js-apis-statfs.md
浏览文件 @
d93d9aee
...
...
@@ -10,19 +10,6 @@
```
js
import
statfs
from
'
@ohos.statfs
'
;
```
## 使用说明
使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:
[
Context模块的接口getOrCreateLocalDir
](
js-apis-Context.md
)
。
“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名”
通过上述接口获取到应用目录路径dir,以文件名“xxx.txt”为例,文件所在应用沙箱路径为:
```
js
let
path
=
dir
+
"
xxx.txt
"
;
```
## statfs.getFreeBytes
getFreeBytes(path:string):Promise
<
number
>
...
...
@@ -72,9 +59,13 @@ getFreeBytes(path:string, callback:AsyncCallback<number>): void
-
示例:
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
context
.
getFilesDir
().
then
(
function
(
path
)
{
statfs
.
getFreeBytes
(
path
,
function
(
err
,
number
){
console
.
info
(
"
getFreeBytes callback successfully:
"
+
number
);
});
});
```
## statfs.getTotalBytes
...
...
@@ -126,8 +117,12 @@ getTotalBytes(path: string, callback: AsyncCallback<number>): void
-
示例:
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
context
=
featureAbility
.
getContext
();
context
.
getFilesDir
().
then
(
function
(
path
)
{
statfs
.
getTotalBytes
(
path
,
function
(
err
,
number
){
console
.
info
(
"
getTotalBytes callback successfully:
"
+
number
);
});
});
```
zh-cn/application-dev/reference/apis/js-apis-system-file.md
浏览文件 @
d93d9aee
...
...
@@ -154,7 +154,7 @@ export default {
file.list({
uri: 'internal://app/pic',
success: function(data) {
console.log(
data.fileList
);
console.log(
JSON.stringify(data.fileList)
);
},
fail: function(data, code) {
console.error('call fail callback fail, code: ' + code + ', data: ' + data);
...
...
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
浏览文件 @
d93d9aee
...
...
@@ -54,7 +54,7 @@ getAllVolumes(callback: AsyncCallback<Array<Volume>>): void
```
js
let
uuid
=
""
;
volumemanager
.
getAllVolumes
(
uuid
,
function
(
error
,
volumes
){
volumemanager
.
getAllVolumes
(
function
(
error
,
volumes
){
// do something
});
```
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录