Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Tonvia
Docs
提交
090fe75f
D
Docs
项目概览
Tonvia
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
0
Fork
0
代码
文件
提交
分支
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看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
090fe75f
编写于
2月 01, 2023
作者:
O
openharmony_ci
提交者:
Gitee
2月 01, 2023
浏览文件
操作
浏览文件
下载
差异文件
!14132 fileapi 回调格式调整&bugfix
Merge pull request !14132 from zhuhongtao666/fsdoc
上级
0107ce92
83c08ee5
变更
5
隐藏空白更改
内联
并排
Showing
5 changed file
with
27 addition
and
27 deletion
+27
-27
zh-cn/application-dev/reference/apis/js-apis-file-environment.md
...pplication-dev/reference/apis/js-apis-file-environment.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-file-fs.md
zh-cn/application-dev/reference/apis/js-apis-file-fs.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-file-hash.md
zh-cn/application-dev/reference/apis/js-apis-file-hash.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-file-securityLabel.md
...lication-dev/reference/apis/js-apis-file-securityLabel.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-file-statvfs.md
zh-cn/application-dev/reference/apis/js-apis-file-statvfs.md
+6
-6
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-file-environment.md
浏览文件 @
090fe75f
...
...
@@ -30,9 +30,9 @@ getStorageDataDir():Promise<string>
**示例:**
```
js
environment
.
getStorageDataDir
().
then
(
function
(
path
)
{
environment
.
getStorageDataDir
().
then
(
(
path
)
=>
{
console
.
info
(
"
getStorageDataDir successfully, Path:
"
+
path
);
}).
catch
(
function
(
err
)
{
}).
catch
(
(
err
)
=>
{
console
.
info
(
"
getStorageDataDir failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
});
```
...
...
@@ -54,7 +54,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void
**示例:**
```
js
environment
.
getStorageDataDir
(
function
(
error
,
path
)
{
environment
.
getStorageDataDir
(
(
err
,
path
)
=>
{
if
(
err
)
{
console
.
info
(
"
getStorageDataDir failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
}
else
{
...
...
@@ -80,9 +80,9 @@ getUserDataDir():Promise<string>
**示例:**
```
js
environment
.
getUserDataDir
().
then
(
function
(
path
)
{
environment
.
getUserDataDir
().
then
(
(
path
)
=>
{
console
.
info
(
"
getUserDataDir successfully, Path:
"
+
path
);
}).
catch
(
function
(
err
)
{
}).
catch
(
(
err
)
=>
{
console
.
info
(
"
getUserDataDir failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
});
```
...
...
@@ -104,7 +104,7 @@ getUserDataDir(callback:AsyncCallback<string>): void
**示例:**
```
js
environment
.
getUserDataDir
(
function
(
err
,
path
)
{
environment
.
getUserDataDir
(
(
err
,
path
)
=>
{
if
(
err
)
{
console
.
info
(
"
getUserDataDir failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
}
else
{
...
...
zh-cn/application-dev/reference/apis/js-apis-file-fs.md
浏览文件 @
090fe75f
...
...
@@ -481,7 +481,7 @@ mkdirSync(path: string): void
## fs.open
open(path: string,
flags
?: number): Promise
<
File
>
open(path: string,
mode
?: number): Promise
<
File
>
打开文件,使用Promise异步回调。支持使用URI打开文件。
...
...
@@ -492,7 +492,7 @@ open(path: string, flags?: number): Promise<File>
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| path | string | 是 | 文件的应用沙箱路径或文件URI。 |
|
flags
| number | 否 | 打开文件的
[
选项
](
#openmode
)
,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
OpenMode.READ_ONLY(0o0):只读打开。
<br/>
-
OpenMode.WRITE_ONLY(0o1):只写打开。
<br/>
-
OpenMode.READ_WRITE(0o2):读写打开。
<br/>
给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
OpenMode.CREATE(0o100):若文件不存在,则创建文件。
<br/>
-
OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。
<br/>
-
OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
OpenMode.DIR(0o200000):如果path不指向目录,则出错。
<br/>
-
OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。
<br/>
-
OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
|
mode
| number | 否 | 打开文件的
[
选项
](
#openmode
)
,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
OpenMode.READ_ONLY(0o0):只读打开。
<br/>
-
OpenMode.WRITE_ONLY(0o1):只写打开。
<br/>
-
OpenMode.READ_WRITE(0o2):读写打开。
<br/>
给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
OpenMode.CREATE(0o100):若文件不存在,则创建文件。
<br/>
-
OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。
<br/>
-
OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
OpenMode.DIR(0o200000):如果path不指向目录,则出错。
<br/>
-
OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。
<br/>
-
OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
**返回值:**
...
...
@@ -514,7 +514,7 @@ open(path: string, flags?: number): Promise<File>
## fs.open
open(path: string,
flags
?: number, callback: AsyncCallback
<
File
>
): void
open(path: string,
mode
?: number, callback: AsyncCallback
<
File
>
): void
打开文件,使用callback异步回调。支持使用URI打开文件。
...
...
@@ -525,7 +525,7 @@ open(path: string, flags?: number, callback: AsyncCallback<File>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| path | string | 是 | 文件的应用沙箱路径或URI。 |
|
flags
| number | 否 | 打开文件的
[
选项
](
#openmode
)
,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
OpenMode.READ_ONLY(0o0):只读打开。
<br/>
-
OpenMode.WRITE_ONLY(0o1):只写打开。
<br/>
-
OpenMode.READ_WRITE(0o2):读写打开。
<br/>
给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
OpenMode.CREATE(0o100):若文件不存在,则创建文件。
<br/>
-
OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。
<br/>
-
OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
OpenMode.DIR(0o200000):如果path不指向目录,则出错。
<br/>
-
OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。
<br/>
-
OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
|
mode
| number | 否 | 打开文件的
[
选项
](
#openmode
)
,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
OpenMode.READ_ONLY(0o0):只读打开。
<br/>
-
OpenMode.WRITE_ONLY(0o1):只写打开。
<br/>
-
OpenMode.READ_WRITE(0o2):读写打开。
<br/>
给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
OpenMode.CREATE(0o100):若文件不存在,则创建文件。
<br/>
-
OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。
<br/>
-
OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
OpenMode.DIR(0o200000):如果path不指向目录,则出错。
<br/>
-
OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。
<br/>
-
OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
**示例:**
...
...
@@ -542,7 +542,7 @@ open(path: string, flags?: number, callback: AsyncCallback<File>): void
## fs.openSync
openSync(path: string,
flags
?: number): File
openSync(path: string,
mode
?: number): File
以同步方法打开文件。支持使用URI打开文件。
...
...
@@ -553,7 +553,7 @@ openSync(path: string, flags?: number): File
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| path | string | 是 | 打开文件的应用沙箱路径或URI。 |
|
flags
| number | 否 | 打开文件的
[
选项
](
#openmode
)
,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
OpenMode.READ_ONLY(0o0):只读打开。
<br/>
-
OpenMode.WRITE_ONLY(0o1):只写打开。
<br/>
-
OpenMode.READ_WRITE(0o2):读写打开。
<br/>
给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
OpenMode.CREATE(0o100):若文件不存在,则创建文件。
<br/>
-
OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。
<br/>
-
OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
OpenMode.DIR(0o200000):如果path不指向目录,则出错。
<br/>
-
OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。
<br/>
-
OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
|
mode
| number | 否 | 打开文件的
[
选项
](
#openmode
)
,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
OpenMode.READ_ONLY(0o0):只读打开。
<br/>
-
OpenMode.WRITE_ONLY(0o1):只写打开。
<br/>
-
OpenMode.READ_WRITE(0o2):读写打开。
<br/>
给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
OpenMode.CREATE(0o100):若文件不存在,则创建文件。
<br/>
-
OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。
<br/>
-
OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
OpenMode.DIR(0o200000):如果path不指向目录,则出错。
<br/>
-
OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。
<br/>
-
OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
**返回值:**
...
...
zh-cn/application-dev/reference/apis/js-apis-file-hash.md
浏览文件 @
090fe75f
...
...
@@ -67,9 +67,9 @@ hash(path: string, algorithm: string): Promise<string>
```
js
let
filePath
=
pathDir
+
"
/test.txt
"
;
Hash
.
hash
(
filePath
,
"
sha256
"
).
then
(
function
(
str
)
{
Hash
.
hash
(
filePath
,
"
sha256
"
).
then
(
(
str
)
=>
{
console
.
info
(
"
calculate file hash succeed:
"
+
str
);
}).
catch
(
function
(
err
)
{
}).
catch
(
(
err
)
=>
{
console
.
info
(
"
calculate file hash failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
});
```
...
...
@@ -92,7 +92,7 @@ hash(path: string, algorithm: string, callback: AsyncCallback<string>): vo
**示例:**
```
js
Hash
.
hash
(
filePath
,
"
sha256
"
,
function
(
err
,
str
)
{
Hash
.
hash
(
filePath
,
"
sha256
"
,
(
err
,
str
)
=>
{
if
(
err
)
{
console
.
info
(
"
calculate file hash failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
}
else
{
...
...
zh-cn/application-dev/reference/apis/js-apis-file-securityLabel.md
浏览文件 @
090fe75f
...
...
@@ -66,9 +66,9 @@ setSecurityLabel(path:string, type:dataLevel):Promise<void>
**示例:**
```
js
securityLabel
.
setSecurityLabel
(
path
,
"
s0
"
).
then
(
function
()
{
securityLabel
.
setSecurityLabel
(
path
,
"
s0
"
).
then
(
()
=>
{
console
.
info
(
"
setSecurityLabel successfully
"
);
}).
catch
(
function
(
err
)
{
}).
catch
(
(
err
)
=>
{
console
.
info
(
"
setSecurityLabel failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
});
```
...
...
@@ -92,7 +92,7 @@ setSecurityLabel(path:string, type:dataLevel, callback: AsyncCallback<void>
**示例:**
```
js
securityLabel
.
setSecurityLabel
(
path
,
"
s0
"
,
function
(
err
)
{
securityLabel
.
setSecurityLabel
(
path
,
"
s0
"
,
(
err
)
=>
{
if
(
err
)
{
console
.
info
(
"
setSecurityLabel failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
}
else
{
...
...
@@ -145,9 +145,9 @@ getSecurityLabel(path:string):Promise<string>
**示例:**
```
js
securityLabel
.
getSecurityLabel
(
path
).
then
(
function
(
type
)
{
securityLabel
.
getSecurityLabel
(
path
).
then
(
(
type
)
=>
{
console
.
log
(
"
getSecurityLabel successfully, Label:
"
+
type
);
}).
catch
(
function
(
err
)
{
}).
catch
(
(
err
)
=>
{
console
.
log
(
"
getSecurityLabel failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
});
```
...
...
@@ -170,7 +170,7 @@ getSecurityLabel(path:string, callback:AsyncCallback<string>): void
**示例:**
```
js
securityLabel
.
getSecurityLabel
(
path
,
function
(
err
,
type
)
{
securityLabel
.
getSecurityLabel
(
path
,
(
err
,
type
)
=>
{
if
(
err
)
{
console
.
log
(
"
getSecurityLabel failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
}
else
{
...
...
zh-cn/application-dev/reference/apis/js-apis-file-statvfs.md
浏览文件 @
090fe75f
...
...
@@ -35,9 +35,9 @@ getFreeSize(path:string):Promise<number>
```
js
let
path
=
"
/dev
"
;
statfs
.
getFreeSize
(
path
).
then
(
function
(
number
)
{
statfs
.
getFreeSize
(
path
).
then
(
(
number
)
=>
{
console
.
info
(
"
getFreeSize promise successfully, Size:
"
+
number
);
}).
catch
(
function
(
err
)
{
}).
catch
(
(
err
)
=>
{
console
.
info
(
"
getFreeSize failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
});
```
...
...
@@ -61,7 +61,7 @@ getFreeSize(path:string, callback:AsyncCallback<number>): void
```
js
let
path
=
"
/dev
"
;
statfs
.
getFreeSize
(
path
,
function
(
err
,
number
)
{
statfs
.
getFreeSize
(
path
,
(
err
,
number
)
=>
{
if
(
err
)
{
console
.
info
(
"
getFreeSize failed with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
}
else
{
...
...
@@ -94,9 +94,9 @@ getTotalSize(path: string): Promise<number>
```
js
let
path
=
"
/dev
"
;
statfs
.
getTotalSize
(
path
).
then
(
function
(
number
)
{
statfs
.
getTotalSize
(
path
).
then
(
(
number
)
=>
{
console
.
info
(
"
getTotalSize promise successfully, Size:
"
+
number
);
}).
catch
(
function
(
err
)
{
}).
catch
(
(
err
)
=>
{
console
.
info
(
"
getTotalSize with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
});
```
...
...
@@ -120,7 +120,7 @@ getTotalSize(path: string, callback: AsyncCallback<number>): void
```
js
let
path
=
"
/dev
"
;
statfs
.
getTotalSize
(
path
,
function
(
err
,
number
)
{
statfs
.
getTotalSize
(
path
,
(
err
,
number
)
=>
{
if
(
err
)
{
console
.
info
(
"
getTotalSize with error message:
"
+
err
.
message
+
"
, error code:
"
+
err
.
code
);
}
else
{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录