From 4b7a1fc86a00ac7c77763f744d82f8b1110df539 Mon Sep 17 00:00:00 2001 From: bi-hu Date: Thu, 9 Mar 2023 16:13:35 +0800 Subject: [PATCH] Delete test interface data in process module Signed-off-by: bi-hu --- .../reference/apis/js-apis-process.md | 316 +----------------- .../reference/apis/js-apis-util.md | 2 +- 2 files changed, 2 insertions(+), 316 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-process.md b/zh-cn/application-dev/reference/apis/js-apis-process.md index 8f9f63a038..eb8f6cf090 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-process.md +++ b/zh-cn/application-dev/reference/apis/js-apis-process.md @@ -18,13 +18,8 @@ import process from '@ohos.process'; | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| egid | number | 是 | 否 | 进程的有效组标识。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。| -| euid | number | 是 | 否 | 进程的有效用户身份。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。 | -| gid | number | 是 | 否 | 进程的组标识。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。| | uid | number | 是 | 否 | 进程的用户标识。 | -| groups | number[] | 是 | 否 | 带有补充组id的数组。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。 | | pid | number | 是 | 否 | 当前进程的pid。 | -| ppid | number | 是 | 否 | 当前进程的父进程的pid。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。 | | tid8+ | number | 是 | 否 | 当前线程的tid。 | @@ -120,50 +115,6 @@ let result = process.getPastCpuTime() ; ``` -## process.runCmd - -runCmd(command: string, options?: { timeout?: number, killSignal?: number | string, maxBuffer?: number }): ChildProcess - -通过runcmd可以fork一个新的进程来运行一段shell，并返回ChildProcess对象。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| command | string | 是 | shell命令。 | -| options | Object | 否 | 相关选项参数。 | - -**表1** options - -| 名称 | 参数类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| timeout | number | 否 | 子进程运行的毫秒数，当子进程运行时间超出此时间，则父进程发送killSignal信号给子进程。timeout默认为0。 | -| killSignal | number \| string | 否 | 子进程运行时间超出timeout时，父进程发送killSignal 信号给子进程。killSignal 默认为'SIGTERM'。 | -| maxBuffer | number | 否 | 子进程标准输入输出的最大缓冲区大小，当超出此大小时则终止子进程。maxBuffer默认1024\*1024。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| [ChildProcess](#childprocess) | 子进程对象。 | - -**示例：** - -```js -let child = process.runCmd('ls', { maxBuffer : 2 }); -let result = child.wait(); -child.getOutput.then(val=>{ - console.log("child.getOutput = " + val); -}) -``` - - ## process.abort abort(): void @@ -179,118 +130,6 @@ process.abort(); ``` -## process.on - -on(type: string, listener: EventListener): void - -存储用户所触发的事件。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| type | string | 是 | 存储事件的type。 | -| listener | [EventListener](#eventlistener) | 是 | 回调的事件。 | - -**示例：** - -```js -process.on("data", (e)=>{ - console.log("data callback"); -}) -``` - - -## process.off - -off(type: string): boolean - -删除用户存储的事件。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| type | string | 是 | 删除事件的type。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| boolean | 事件删除成功则返回true，没有成功则为false。| - -**示例：** - -```js -process.on("data", (e)=>{ - console.log("data callback"); -}) -let result = process.off("data"); -``` - - -## process.cwd - -cwd(): string - -获取进程的工作目录。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| string| 返回当前进程的工作目录。 | - -**示例：** - -```js -let path = process.cwd(); -``` - - -## process.chdir - -chdir(dir: string): void - -更改进程的当前工作目录。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| dir | string | 是 | 路径。 | - -**示例：** - -```js -process.chdir('/system'); -``` - - ## process.uptime uptime(): number @@ -728,157 +567,4 @@ kill(signal: number, pid: number): boolean let pro = new process.ProcessManager(); let pres = process.pid; let result = pro.kill(28, pres); -``` - - -## ChildProcess - -ChildProcess对象为创建的新的子进程，主进程可以获取子进程的标准输入输出，以及发送信号和关闭子进程，可以通过[process.runCmd](#processruncmd)获取ChildProcess对象。 - -**系统接口：** 此接口为系统接口。 - -### 属性 - -**系统接口：** 此接口为系统接口。 - -**系统能力：** SystemCapability.Utils.Lang - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| pid | number | 是 | 否 | 子进程的pid。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。 | -| ppid | number | 是 | 否 | 子进程的父进程的pid。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。 | -| exitCode | number | 是 | 否 | 子进程的退出码。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。| -| killed | boolean | 是 | 否 | 父进程给子进程发信号是否成功。
**系统接口：** 此接口为系统接口。
此接口仅用于对应用的测试。 | - - -### wait - -wait(): Promise<number> - -等待子进程运行结束，返回promise对象，其值为子进程的退出码。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise<number> | 异步返回子进程的退出码。 | - -**示例：** - -```js -let child = process.runCmd('ls'); -let result = child.wait(); -result.then(val=>{ - console.log("result = " + val); -}) -``` - - -### getOutput - -getOutput(): Promise<Uint8Array> - -获取子进程的标准输出。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise<Uint8Array> | 异步返回标准输出的字节流。 | - -**示例：** - -```js -let child = process.runCmd('ls'); -let result = child.wait(); -child.getOutput().then(val=>{ - console.log("child.getOutput = " + val); -}) -``` - - -### getErrorOutput - -getErrorOutput(): Promise<Uint8Array> - -获取子进程的标准错误输出。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise<Uint8Array> | 异步返回标准错误输出的字节流。 | - -**示例：** - -```js -let child = process.runCmd('madir test.text'); -let result = child.wait(); -child.getErrorOutput().then(val=>{ - console.log("child.getErrorOutput= " + val); -}) -``` - - -### close - -close(): void - -关闭正在运行的子进程。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**示例：** - -```js -let child = process.runCmd('sleep 5; ls'); -child.close(); -``` - - -### kill - -kill(signal: number | string): void - -用于发送信号给子进程，结束指定进程。 - -**系统接口：** 此接口为系统接口。 - -此接口仅用于对应用的测试。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| signal | number \| string | 是 | 数字或字符串。 | - -**示例：** - -```js -let child = process.runCmd('sleep 5; ls'); -child.kill(9); -``` +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-util.md b/zh-cn/application-dev/reference/apis/js-apis-util.md index 0254aca1a6..1e097c20cf 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-util.md +++ b/zh-cn/application-dev/reference/apis/js-apis-util.md @@ -110,7 +110,7 @@ async function fn() { return 'hello world'; } let cb = util.callbackWrapper(fn); -cb((err, ret) => { +cb(1, (err, ret) => { if (err) throw err; console.log(ret); }); -- GitLab