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

!14132 fileapi 回调格式调整&bugfix

Merge pull request !14132 from zhuhongtao666/fsdoc
...@@ -30,9 +30,9 @@ getStorageDataDir():Promise<string> ...@@ -30,9 +30,9 @@ getStorageDataDir():Promise<string>
**示例:** **示例:**
```js ```js
environment.getStorageDataDir().then(function (path) { environment.getStorageDataDir().then((path) => {
console.info("getStorageDataDir successfully, Path: " + 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); console.info("getStorageDataDir failed with error message: " + err.message + ", error code: " + err.code);
}); });
``` ```
...@@ -54,7 +54,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void ...@@ -54,7 +54,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void
**示例:** **示例:**
```js ```js
environment.getStorageDataDir(function (error, path) { environment.getStorageDataDir((err, path) => {
if (err) { if (err) {
console.info("getStorageDataDir failed with error message: " + err.message + ", error code: " + err.code); console.info("getStorageDataDir failed with error message: " + err.message + ", error code: " + err.code);
} else { } else {
...@@ -80,9 +80,9 @@ getUserDataDir():Promise<string> ...@@ -80,9 +80,9 @@ getUserDataDir():Promise<string>
**示例:** **示例:**
```js ```js
environment.getUserDataDir().then(function (path) { environment.getUserDataDir().then((path) => {
console.info("getUserDataDir successfully, Path: " + 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); console.info("getUserDataDir failed with error message: " + err.message + ", error code: " + err.code);
}); });
``` ```
...@@ -104,7 +104,7 @@ getUserDataDir(callback:AsyncCallback<string>): void ...@@ -104,7 +104,7 @@ getUserDataDir(callback:AsyncCallback<string>): void
**示例:** **示例:**
```js ```js
environment.getUserDataDir(function (err, path) { environment.getUserDataDir((err, path) => {
if (err) { if (err) {
console.info("getUserDataDir failed with error message: " + err.message + ", error code: " + err.code); console.info("getUserDataDir failed with error message: " + err.message + ", error code: " + err.code);
} else { } else {
......
...@@ -481,7 +481,7 @@ mkdirSync(path: string): void ...@@ -481,7 +481,7 @@ mkdirSync(path: string): void
## fs.open ## fs.open
open(path: string, flags?: number): Promise<File> open(path: string, mode?: number): Promise<File>
打开文件,使用Promise异步回调。支持使用URI打开文件。 打开文件,使用Promise异步回调。支持使用URI打开文件。
...@@ -492,7 +492,7 @@ open(path: string, flags?: number): Promise<File> ...@@ -492,7 +492,7 @@ open(path: string, flags?: number): Promise<File>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| path | string | 是 | 文件的应用沙箱路径或文件URI。 | | path | string | 是 | 文件的应用沙箱路径或文件URI。 |
| flags | number | 否 | 打开文件的[选项](#openmode),必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;OpenMode.READ_ONLY(0o0):只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1):只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2):读写打开。<br/>给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;OpenMode.CREATE(0o100):若文件不存在,则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000):如果path不指向目录,则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 | | mode | number | 否 | 打开文件的[选项](#openmode),必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;OpenMode.READ_ONLY(0o0):只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1):只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2):读写打开。<br/>给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;OpenMode.CREATE(0o100):若文件不存在,则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000):如果path不指向目录,则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
**返回值:** **返回值:**
...@@ -514,7 +514,7 @@ open(path: string, flags?: number): Promise&lt;File&gt; ...@@ -514,7 +514,7 @@ open(path: string, flags?: number): Promise&lt;File&gt;
## fs.open ## fs.open
open(path: string, flags?: number, callback: AsyncCallback&lt;File&gt;): void open(path: string, mode?: number, callback: AsyncCallback&lt;File&gt;): void
打开文件,使用callback异步回调。支持使用URI打开文件。 打开文件,使用callback异步回调。支持使用URI打开文件。
...@@ -525,7 +525,7 @@ open(path: string, flags?: number, callback: AsyncCallback&lt;File&gt;): void ...@@ -525,7 +525,7 @@ open(path: string, flags?: number, callback: AsyncCallback&lt;File&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| path | string | 是 | 文件的应用沙箱路径或URI。 | | path | string | 是 | 文件的应用沙箱路径或URI。 |
| flags | number | 否 | 打开文件的[选项](#openmode),必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;OpenMode.READ_ONLY(0o0):只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1):只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2):读写打开。<br/>给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;OpenMode.CREATE(0o100):若文件不存在,则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000):如果path不指向目录,则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 | | mode | number | 否 | 打开文件的[选项](#openmode),必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;OpenMode.READ_ONLY(0o0):只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1):只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2):读写打开。<br/>给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;OpenMode.CREATE(0o100):若文件不存在,则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000):如果path不指向目录,则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
**示例:** **示例:**
...@@ -542,7 +542,7 @@ open(path: string, flags?: number, callback: AsyncCallback&lt;File&gt;): void ...@@ -542,7 +542,7 @@ open(path: string, flags?: number, callback: AsyncCallback&lt;File&gt;): void
## fs.openSync ## fs.openSync
openSync(path: string, flags?: number): File openSync(path: string, mode?: number): File
以同步方法打开文件。支持使用URI打开文件。 以同步方法打开文件。支持使用URI打开文件。
...@@ -553,7 +553,7 @@ openSync(path: string, flags?: number): File ...@@ -553,7 +553,7 @@ openSync(path: string, flags?: number): File
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| path | string | 是 | 打开文件的应用沙箱路径或URI。 | | path | string | 是 | 打开文件的应用沙箱路径或URI。 |
| flags | number | 否 | 打开文件的[选项](#openmode),必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;OpenMode.READ_ONLY(0o0):只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1):只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2):读写打开。<br/>给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;OpenMode.CREATE(0o100):若文件不存在,则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000):如果path不指向目录,则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 | | mode | number | 否 | 打开文件的[选项](#openmode),必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;OpenMode.READ_ONLY(0o0):只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1):只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2):读写打开。<br/>给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;OpenMode.CREATE(0o100):若文件不存在,则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000):如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000):如果path不指向目录,则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。 |
**返回值:** **返回值:**
......
...@@ -67,9 +67,9 @@ hash(path: string, algorithm: string): Promise&lt;string&gt; ...@@ -67,9 +67,9 @@ hash(path: string, algorithm: string): Promise&lt;string&gt;
```js ```js
let filePath = pathDir + "/test.txt"; 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); 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); 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&lt;string&gt;): vo ...@@ -92,7 +92,7 @@ hash(path: string, algorithm: string, callback: AsyncCallback&lt;string&gt;): vo
**示例:** **示例:**
```js ```js
Hash.hash(filePath, "sha256", function (err, str) { Hash.hash(filePath, "sha256", (err, str) => {
if (err) { if (err) {
console.info("calculate file hash failed with error message: " + err.message + ", error code: " + err.code); console.info("calculate file hash failed with error message: " + err.message + ", error code: " + err.code);
} else { } else {
......
...@@ -66,9 +66,9 @@ setSecurityLabel(path:string, type:dataLevel):Promise&lt;void&gt; ...@@ -66,9 +66,9 @@ setSecurityLabel(path:string, type:dataLevel):Promise&lt;void&gt;
**示例:** **示例:**
```js ```js
securityLabel.setSecurityLabel(path, "s0").then(function () { securityLabel.setSecurityLabel(path, "s0").then(() => {
console.info("setSecurityLabel successfully"); console.info("setSecurityLabel successfully");
}).catch(function (err) { }).catch((err) => {
console.info("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code); console.info("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
}); });
``` ```
...@@ -92,7 +92,7 @@ setSecurityLabel(path:string, type:dataLevel, callback: AsyncCallback&lt;void&gt ...@@ -92,7 +92,7 @@ setSecurityLabel(path:string, type:dataLevel, callback: AsyncCallback&lt;void&gt
**示例:** **示例:**
```js ```js
securityLabel.setSecurityLabel(path, "s0", function (err) { securityLabel.setSecurityLabel(path, "s0", (err) => {
if (err) { if (err) {
console.info("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code); console.info("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
} else { } else {
...@@ -145,9 +145,9 @@ getSecurityLabel(path:string):Promise&lt;string&gt; ...@@ -145,9 +145,9 @@ getSecurityLabel(path:string):Promise&lt;string&gt;
**示例:** **示例:**
```js ```js
securityLabel.getSecurityLabel(path).then(function (type) { securityLabel.getSecurityLabel(path).then((type) => {
console.log("getSecurityLabel successfully, Label: " + 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); console.log("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
}); });
``` ```
...@@ -170,7 +170,7 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void ...@@ -170,7 +170,7 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void
**示例:** **示例:**
```js ```js
securityLabel.getSecurityLabel(path, function (err, type) { securityLabel.getSecurityLabel(path, (err, type) => {
if (err) { if (err) {
console.log("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code); console.log("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
} else { } else {
......
...@@ -35,9 +35,9 @@ getFreeSize(path:string):Promise&lt;number&gt; ...@@ -35,9 +35,9 @@ getFreeSize(path:string):Promise&lt;number&gt;
```js ```js
let path = "/dev"; let path = "/dev";
statfs.getFreeSize(path).then(function (number) { statfs.getFreeSize(path).then((number) => {
console.info("getFreeSize promise successfully, Size: " + 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); console.info("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
}); });
``` ```
...@@ -61,7 +61,7 @@ getFreeSize(path:string, callback:AsyncCallback&lt;number&gt;): void ...@@ -61,7 +61,7 @@ getFreeSize(path:string, callback:AsyncCallback&lt;number&gt;): void
```js ```js
let path = "/dev"; let path = "/dev";
statfs.getFreeSize(path, function (err, number) { statfs.getFreeSize(path, (err, number) => {
if (err) { if (err) {
console.info("getFreeSize failed with error message: " + err.message + ", error code: " + err.code); console.info("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
} else { } else {
...@@ -94,9 +94,9 @@ getTotalSize(path: string): Promise&lt;number&gt; ...@@ -94,9 +94,9 @@ getTotalSize(path: string): Promise&lt;number&gt;
```js ```js
let path = "/dev"; let path = "/dev";
statfs.getTotalSize(path).then(function (number) { statfs.getTotalSize(path).then((number) => {
console.info("getTotalSize promise successfully, Size: " + 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); console.info("getTotalSize with error message: " + err.message + ", error code: " + err.code);
}); });
``` ```
...@@ -120,7 +120,7 @@ getTotalSize(path: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -120,7 +120,7 @@ getTotalSize(path: string, callback: AsyncCallback&lt;number&gt;): void
```js ```js
let path = "/dev"; let path = "/dev";
statfs.getTotalSize(path, function(err, number) { statfs.getTotalSize(path, (err, number) => {
if (err) { if (err) {
console.info("getTotalSize with error message: " + err.message + ", error code: " + err.code); console.info("getTotalSize with error message: " + err.message + ", error code: " + err.code);
} else { } else {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册