From 0d42e4474b30c8b429890edd1748c0ff3386cd52 Mon Sep 17 00:00:00 2001 From: Gloria Date: Wed, 8 Mar 2023 15:38:07 +0800 Subject: [PATCH] Update docs against 14822 Signed-off-by: wusongqing --- .../reference/apis/js-apis-process.md | 655 ++++++++++-------- 1 file changed, 349 insertions(+), 306 deletions(-) diff --git a/en/application-dev/reference/apis/js-apis-process.md b/en/application-dev/reference/apis/js-apis-process.md index 318ba30799..02dbfe617a 100755 --- a/en/application-dev/reference/apis/js-apis-process.md +++ b/en/application-dev/reference/apis/js-apis-process.md @@ -18,139 +18,117 @@ import process from '@ohos.process'; | Name| Type| Readable| Writable| Description| | -------- | -------- | -------- | -------- | -------- | -| egid | number | Yes| No| Effective group identifier (EGID) of a process.
**System API**: This is a system API.
It is used only to test applications.| -| euid | number | Yes| No| Effective user identifier (EUID) of a process.
**System API**: This is a system API.
It is used only to test applications.| -| gid | number | Yes| No| Group identifier (GID) of a process.
**System API**: This is a system API.
It is used only to test applications.| -| uid | number | Yes| No| User identifier (UID) of a process.| +| egid | number | Yes| No| Effective group identifier (EGID) of the process.
**System API**: This is a system API.
It is used only to test applications.| +| euid | number | Yes| No| Effective user identifier (EUID) of the process.
**System API**: This is a system API.
It is used only to test applications.| +| gid | number | Yes| No| Group identifier (GID) of the process.
**System API**: This is a system API.
It is used only to test applications.| +| uid | number | Yes| No| User identifier (UID) of the process.| | groups | number[] | Yes| No| Array with supplementary group IDs.
**System API**: This is a system API.
It is used only to test applications.| -| pid | number | Yes| No| Process ID (PID) of a process.| -| ppid | number | Yes| No| Parent process ID (PPID) of a process.
**System API**: This is a system API.
It is used only to test applications.| -| tid8+ | number | Yes| No| Thread ID (TID) of a process.| +| pid | number | Yes| No| Process ID (PID) of the process.| +| ppid | number | Yes| No| Parent process ID (PPID) of the process.
**System API**: This is a system API.
It is used only to test applications.| +| tid8+ | number | Yes| No| Thread ID (TID) of the thread.| -## ProcessManager9+ +## EventListener -Provides APIs for throwing exceptions during the addition of a process. +**System capability**: SystemCapability.Utils.Lang -### isAppUid9+ +| Name| Description| +| -------- | -------- | +| EventListener = (evt:  Object) => void | Event to store.| -isAppUid(v: number): boolean -Checks whether a UID belongs to this application. +## process.isIsolatedProcess8+ -**System capability**: SystemCapability.Utils.Lang +isIsolatedProcess(): boolean -**Parameters** +Checks whether this process is isolated. -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| v | number | Yes| UID.| +**System capability**: SystemCapability.Utils.Lang **Return value** | Type| Description| | -------- | -------- | -| boolean | Returns **true** if the UID is the application's UID; returns **false** otherwise.| +| boolean | Returns **true** if the process is isolated; returns **false** otherwise.| **Example** ```js -let pro = new process.ProcessManager(); -let result = pro.isAppUid(688); +let result = process.isIsolatedProcess(); ``` -### getUidForName9+ +## process.is64Bit8+ -getUidForName(v: string): number +is64Bit(): boolean -Obtains the process UID based on the process name. +Checks whether this process is running in a 64-bit environment. **System capability**: SystemCapability.Utils.Lang -**Parameters** - -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| v | string | Yes| Name of a process.| - **Return value** | Type| Description| | -------- | -------- | -| number | Process UID.| +| boolean | Returns **true** if the process is running in a 64-bit environment; returns **false** otherwise.| **Example** ```js -let pro = new process.ProcessManager(); -let pres = pro .getUidForName("tool"); +let result = process.is64Bit(); ``` -### getThreadPriority9+ +## process.getStartRealtime8+ -getThreadPriority(v: number): number +getStartRealtime(): number -Obtains the thread priority based on the specified TID. +Obtains the duration, in milliseconds, from the time the system starts to the time the process starts. **System capability**: SystemCapability.Utils.Lang -**Parameters** - -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| v | number | Yes| TID.| - **Return value** | Type| Description| | -------- | -------- | -| number | Priority of the thread.| +| number | Duration obtained, in millisecond.| **Example** ```js -let pro = new process.ProcessManager(); -let tid = process.tid; -let pres = pro.getThreadPriority(tid); +let realtime = process.getStartRealtime(); ``` +## process.getPastCpuTime8+ -### getSystemConfig9+ - -getSystemConfig(name: number): number +getPastCpuTime(): number -Obtains the system configuration. +Obtains the CPU time (in milliseconds) from the time the process starts to the current time. **System capability**: SystemCapability.Utils.Lang -**Parameters** - -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| name | number | Yes| System configuration parameter name.| - **Return value** | Type| Description| | -------- | -------- | -| number | System configuration obtained.| +| number | CPU time obtained, in millisecond.| **Example** ```js -let pro = new process.ProcessManager(); -let _SC_ARG_MAX = 0; -let pres = pro.getSystemConfig(_SC_ARG_MAX); +let result = process.getPastCpuTime() ; ``` -### getEnvironmentVar9+ +## process.runCmd -getEnvironmentVar(name: string): string +runCmd(command: string, options?: { timeout?: number, killSignal?: number | string, maxBuffer?: number }): ChildProcess -Obtains the value of an environment variable. +Forks a new process to run a shell command and returns the **ChildProcess** object. + +**System API**: This is a system API. + +It is used only to test applications. **System capability**: SystemCapability.Utils.Lang @@ -158,29 +136,58 @@ Obtains the value of an environment variable. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| name | string | Yes| Environment variable name.| +| command | string | Yes| Shell command to run.| +| options | Object | No| Related parameters.| + +**Table 1** options + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| timeout | number | No| Maximum running time (in milliseconds) of the child process. When the running time of the child process exceeds the value of this parameter, the parent process sends a **killSignal** to the child process to terminate it. The default value is **0**.| +| killSignal | number \| string | No| Signal sent to the child process when the running time of a child process exceeds the timeout period. The default value is **SIGTERM**.| +| maxBuffer | number | No| Maximum buffer size for the standard input and output of the child process. When the size is exceeded, the child process will be terminated. The default value is **1024 \* 1024**.| **Return value** | Type| Description| | -------- | -------- | -| string | Value of the environment variable.| +| [ChildProcess](#childprocess) | **ChildProcess** object.| **Example** ```js -let pro = new process.ProcessManager(); -let pres = pro.getEnvironmentVar("PATH"); +let child = process.runCmd('ls', { maxBuffer : 2 }); +let result = child.wait(); +child.getOutput.then(val=>{ + console.log("child.getOutput = " + val); +}) ``` -### exit9+ +## process.abort -exit(code: number): void +abort(): void -Terminates this process. +Aborts a process and generates a core file. This method will cause a process to exit immediately. Exercise caution when using this method. + +**System capability**: SystemCapability.Utils.Lang -Exercise caution when using this API. +**Example** + +```js +process.abort(); +``` + + +## process.on + +on(type: string, listener: EventListener): void + +Stores the events triggered by the user. + +**System API**: This is a system API. + +It is used only to test applications. **System capability**: SystemCapability.Utils.Lang @@ -188,21 +195,27 @@ Exercise caution when using this API. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| code | number | Yes| Exit code of the process.| +| type | string | Yes| Type of the events to store. | +| listener | [EventListener](#eventlistener) | Yes| Callback invoked to return the event.| **Example** ```js -let pro = new process.ProcessManager(); -pro.exit(0); +process.on("data", (e)=>{ + console.log("data callback"); +}) ``` -### kill9+ +## process.off -kill(signal: number, pid: number): boolean +off(type: string): boolean -Sends a signal to the specified process to terminate it. +Deletes the event stored by the user. + +**System API**: This is a system API. + +It is used only to test applications. **System capability**: SystemCapability.Utils.Lang @@ -210,45 +223,29 @@ Sends a signal to the specified process to terminate it. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| pid | number | Yes| PID of the process, to which the signal will be sent.| -| signal | number | Yes| Signal to send.| +| type | string | Yes| Type of the event to delete.| **Return value** | Type| Description| | -------- | -------- | -| boolean | Returns **true** if the signal is sent successfully; returns **false** otherwise.| +| boolean | Returns **true** if the event is deleted; returns **false** otherwise.| **Example** ```js -let pro = new process.ProcessManager(); -let pres = process.pid; -let result = pro.kill(28, pres); +process.on("data", (e)=>{ + console.log("data callback"); +}) +let result = process.off("data"); ``` -## ChildProcess - -Allows a process to obtain the standard input and output of its child processes, send signals, and close its child processes. - -### Attributes - -**System capability**: SystemCapability.Utils.Lang - -| Name| Type| Readable| Writable| Description| -| -------- | -------- | -------- | -------- | -------- | -| pid | number | Yes| No| PID of the child process.
**System API**: This is a system API.
It is used only to test applications.| -| ppid | number | Yes| No| PPID of the child process.
**System API**: This is a system API.
It is used only to test applications.| -| exitCode | number | Yes| No| Exit code of the child process.
**System API**: This is a system API.
It is used only to test applications.| -| killed | boolean | Yes| No| Whether the parent process successfully sends a signal to the child process to terminate it.
**System API**: This is a system API.
It is used only to test applications.| - - -### wait +## process.cwd -wait(): Promise<number> +cwd(): string -Waits until the child process ends. This method uses a promise to return the exit code of the child process. +Obtains the working directory of this process. **System API**: This is a system API. @@ -260,24 +257,20 @@ It is used only to test applications. | Type| Description| | -------- | -------- | -| Promise<number> | Promise used to return the exit code of the child process.| +| string| Working directory obtained.| **Example** ```js -let child = process.runCmd('ls'); -let result = child.wait(); -result.then(val=>{ - console.log("result = " + val); -}) +let path = process.cwd(); ``` -### getOutput +## process.chdir -getOutput(): Promise<Uint8Array> +chdir(dir: string): void -Obtains the standard output of the child process. +Changes the working directory of this process. **System API**: This is a system API. @@ -285,81 +278,109 @@ It is used only to test applications. **System capability**: SystemCapability.Utils.Lang +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| dir | string | Yes| Path| + +**Example** + +```js +process.chdir('/system'); +``` + + +## process.uptime + +uptime(): number + +Obtains the running time of this process. + +**System capability**: SystemCapability.Utils.Lang + **Return value** | Type| Description| | -------- | -------- | -| Promise<Uint8Array> | Promise used to return the standard output in a Uint8Array.| +| number | Running time of the process, in seconds.| **Example** ```js -let child = process.runCmd('ls'); -let result = child.wait(); -child.getOutput().then(val=>{ - console.log("child.getOutput = " + val); -}) +let time = process.uptime(); ``` -### getErrorOutput +## process.kill(deprecated) -getErrorOutput(): Promise<Uint8Array> - -Obtains the standard error output of the child process. +kill(signal: number, pid: number): boolean -**System API**: This is a system API. +Sends a signal to the specified process to terminate it. -It is used only to test applications. +> **NOTE** +> +> This API is supported since API version 7 and deprecated since API version 9. You are advised to use [kill9+](#kill9) instead. **System capability**: SystemCapability.Utils.Lang +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pid | number | Yes| PID of the process, to which the signal will be sent.| +| signal | number | Yes| Signal to send.| + **Return value** | Type| Description| | -------- | -------- | -| Promise<Uint8Array> | Promise used to return the standard error output in a Uint8Array.| +| boolean | Returns **true** if the signal is sent successfully; returns **false** otherwise.| **Example** ```js -let child = process.runCmd('madir test.text'); -let result = child.wait(); -child.getErrorOutput().then(val=>{ - console.log("child.getErrorOutput= " + val); -}) +let pres = process.pid +let result = process.kill(28, pres) ``` -### close +## process.exit(deprecated) -close(): void +exit(code: number): void -Closes the child process in running. +Terminates this process. -**System API**: This is a system API. +Exercise caution when using this API. After this API is called, the application exits. If the input parameter is not 0, data loss or exceptions may occur. -It is used only to test applications. +> **NOTE** +> +> This API is supported since API version 7 and deprecated since API version 9. You are advised to use [exit9+](#exit9) instead. **System capability**: SystemCapability.Utils.Lang +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| code | number | Yes| Exit code of the process.| + **Example** ```js -let child = process.runCmd('sleep 5; ls'); -child.close(); +process.exit(0); ``` -### kill - -kill(signal: number | string): void +## process.getUidForName(deprecated) -Sends a signal to the specified child process to terminate it. +getUidForName(v: string): number -**System API**: This is a system API. +Obtains the process UID based on the process name. -It is used only to test applications. +> **NOTE** +> +> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [getUidForName9+](#getuidforname9) instead. **System capability**: SystemCapability.Utils.Lang @@ -367,43 +388,63 @@ It is used only to test applications. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| signal | number \| string | Yes| Number or string to send.| +| v | string | Yes| Name of a process.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Process UID.| **Example** ```js -let child = process.runCmd('sleep 5; ls'); -child.kill(9); +let pres = process.getUidForName("tool") ``` -## process.isIsolatedProcess8+ +## process.getThreadPriority(deprecated) -isIsolatedProcess(): boolean +getThreadPriority(v: number): number -Checks whether this process is isolated. +Obtains the thread priority based on the specified TID. + +> **NOTE** +> +> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [getThreadPriority9+](#getthreadpriority9) instead. **System capability**: SystemCapability.Utils.Lang +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| v | number | Yes| TID.| + **Return value** | Type| Description| | -------- | -------- | -| boolean | Returns **true** if the process is isolated; returns **false** otherwise.| +| number | Priority of the thread.| **Example** ```js -let result = process.isIsolatedProcess(); +let tid = process.tid; +let pres = process.getThreadPriority(tid); ``` -## process.isAppUid8+ +## process.isAppUid(deprecated) isAppUid(v: number): boolean Checks whether a UID belongs to this application. +> **NOTE** +> +> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [isAppUid9+](#isappuid9) instead. + **System capability**: SystemCapability.Utils.Lang **Parameters** @@ -416,7 +457,7 @@ Checks whether a UID belongs to this application. | Type| Description| | -------- | -------- | -| boolean | Returns **true** if the UID is the application's UID; returns **false** otherwise.| +| boolean | Returns **true** if the UID belongs to the application; returns **false** otherwise.| **Example** @@ -425,32 +466,47 @@ let result = process.isAppUid(688); ``` -## process.is64Bit8+ +## process.getSystemConfig(deprecated) -is64Bit(): boolean +getSystemConfig(name: number): number -Checks whether this process is running in a 64-bit environment. +Obtains the system configuration. + +> **NOTE** +> +> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [getSystemConfig9+](#getsystemconfig9) instead. **System capability**: SystemCapability.Utils.Lang +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| name | number | Yes| System configuration parameter name.| + **Return value** | Type| Description| | -------- | -------- | -| boolean | Returns **true** if the process is running in a 64-bit environment; returns **false** otherwise.| +| number | System configuration obtained.| **Example** ```js -let result = process.is64Bit(); +let _SC_ARG_MAX = 0 +let pres = process.getSystemConfig(_SC_ARG_MAX) ``` -## process.getUidForName8+ +## process.getEnvironmentVar(deprecated) -getUidForName(v: string): number +getEnvironmentVar(name: string): string -Obtains the process UID based on the process name. +Obtains the value of an environment variable. + +> **NOTE** +> +> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [getEnvironmentVar9+](#getenvironmentvar9) instead. **System capability**: SystemCapability.Utils.Lang @@ -458,26 +514,32 @@ Obtains the process UID based on the process name. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| v | string | Yes| Name of a process.| +| name | string | Yes| Environment variable name.| **Return value** | Type| Description| | -------- | -------- | -| number | Process UID.| +| string | Value of the environment variable.| **Example** ```js -let pres = process.getUidForName("tool") +let pres = process.getEnvironmentVar("PATH") ``` -## process.getThreadPriority8+ +## ProcessManager9+ + +Provides APIs for throwing exceptions during the addition of a process. + +A **ProcessManager** object is obtained through its own constructor. + +### isAppUid9+ -getThreadPriority(v: number): number +isAppUid(v: number): boolean -Obtains the thread priority based on the specified TID. +Checks whether a UID belongs to this application. **System capability**: SystemCapability.Utils.Lang @@ -485,64 +547,80 @@ Obtains the thread priority based on the specified TID. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| v | number | Yes| TID.| +| v | number | Yes| UID.| **Return value** | Type| Description| | -------- | -------- | -| number | Priority of the thread.| +| boolean | Returns **true** if the UID belongs to the application; returns **false** otherwise.| **Example** ```js -let tid = process.tid; -let pres = process.getThreadPriority(tid); +let pro = new process.ProcessManager(); +let result = pro.isAppUid(688); ``` -## process.getStartRealtime8+ +### getUidForName9+ -getStartRealtime(): number +getUidForName(v: string): number -Obtains the duration, in milliseconds, from the time the system starts to the time the process starts. +Obtains the process UID based on the process name. **System capability**: SystemCapability.Utils.Lang +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| v | string | Yes| Name of a process.| + **Return value** | Type| Description| | -------- | -------- | -| number | Duration obtained.| +| number | Process UID.| **Example** ```js -let realtime = process.getStartRealtime(); +let pro = new process.ProcessManager(); +let pres = pro .getUidForName("tool"); ``` -## process.getPastCpuTime8+ -getPastCpuTime(): number +### getThreadPriority9+ -Obtains the CPU time (in milliseconds) from the time the process starts to the current time. +getThreadPriority(v: number): number + +Obtains the thread priority based on the specified TID. **System capability**: SystemCapability.Utils.Lang +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| v | number | Yes| TID.| + **Return value** | Type| Description| | -------- | -------- | -| number | CPU time obtained.| +| number | Priority of the thread.| **Example** ```js -let result = process.getPastCpuTime() ; +let pro = new process.ProcessManager(); +let tid = process.tid; +let pres = pro.getThreadPriority(tid); ``` -## process.getSystemConfig8+ +### getSystemConfig9+ getSystemConfig(name: number): number @@ -565,12 +643,13 @@ Obtains the system configuration. **Example** ```js -let _SC_ARG_MAX = 0 -let pres = process.getSystemConfig(_SC_ARG_MAX) +let pro = new process.ProcessManager(); +let _SC_ARG_MAX = 0; +let pres = pro.getSystemConfig(_SC_ARG_MAX); ``` -## process.getEnvironmentVar8+ +### getEnvironmentVar9+ getEnvironmentVar(name: string): string @@ -593,19 +672,18 @@ Obtains the value of an environment variable. **Example** ```js -let pres = process.getEnvironmentVar("PATH") +let pro = new process.ProcessManager(); +let pres = pro.getEnvironmentVar("PATH"); ``` -## process.runCmd - -runCmd(command: string, options?: { timeout?: number, killSignal?: number | string, maxBuffer?: number }): ChildProcess +### exit9+ -Forks a new process to run a shell command and returns the **ChildProcess** object. +exit(code: number): void -**System API**: This is a system API. +Terminates this process. -It is used only to test applications. +Exercise caution when using this API. After this API is called, the application exits. If the input parameter is not 0, data loss or exceptions may occur. **System capability**: SystemCapability.Utils.Lang @@ -613,54 +691,71 @@ It is used only to test applications. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| command | string | Yes| Shell command to run.| -| options | Object | No| Related parameters.| +| code | number | Yes| Exit code of the process.| -**Table 1** options +**Example** + +```js +let pro = new process.ProcessManager(); +pro.exit(0); +``` + + +### kill9+ + +kill(signal: number, pid: number): boolean + +Sends a signal to the specified process to terminate it. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| timeout | number | No| Maximum running time (in ms) of the child process. When the running time of the child process exceeds the value of this parameter, the parent process sends a **killSignal** to the child process to terminate it. The default value is **0**.| -| killSignal | number \| string | No| Signal sent to the child process when the running time of a child process exceeds the timeout period. The default value is **SIGTERM**.| -| maxBuffer | number | No| Maximum buffer size for the standard input and output of the child process. When the size is exceeded, the child process will be terminated. The default value is **1024 \* 1024**.| +| pid | number | Yes| PID of the process, to which the signal will be sent.| +| signal | number | Yes| Signal to send.| **Return value** | Type| Description| | -------- | -------- | -| [ChildProcess](#childprocess) | **ChildProcess** object.| +| boolean | Returns **true** if the signal is sent successfully; returns **false** otherwise.| **Example** ```js -let child = process.runCmd('ls', { maxBuffer : 2 }); -let result = child.wait(); -child.getOutput.then(val=>{ - console.log("child.getOutput = " + val); -}) +let pro = new process.ProcessManager(); +let pres = process.pid; +let result = pro.kill(28, pres); ``` -## process.abort +## ChildProcess -abort(): void +The **ChildProcess** object is a new child process and can be obtained by calling [process.runCmd](#processruncmd). The main process can obtain the standard input and output of the child process, send signals to the child process, and close the child process. -Aborts a process and generates a core file. This method will cause a process to exit immediately. Exercise caution when using this method. +**System API**: This is a system API. -**System capability**: SystemCapability.Utils.Lang +### Attributes -**Example** +**System API**: This is a system API. -```js -process.abort(); -``` +**System capability**: SystemCapability.Utils.Lang + +| Name| Type| Readable| Writable| Description| +| -------- | -------- | -------- | -------- | -------- | +| pid | number | Yes| No| PID of the child process.
**System API**: This is a system API.
It is used only to test applications.| +| ppid | number | Yes| No| PPID of the child process.
**System API**: This is a system API.
It is used only to test applications.| +| exitCode | number | Yes| No| Exit code of the child process.
**System API**: This is a system API.
It is used only to test applications.| +| killed | boolean | Yes| No| Whether the parent process successfully sends a signal to the child process to terminate it.
**System API**: This is a system API.
It is used only to test applications.| -## process.on +### wait -on(type: string, listener: EventListener): void +wait(): Promise<number> -Stores the events triggered by the user. +Waits until the child process ends. This method uses a promise to return the exit code of the child process. **System API**: This is a system API. @@ -668,33 +763,28 @@ It is used only to test applications. **System capability**: SystemCapability.Utils.Lang -**Parameters** - -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| type | string | Yes| Type of the events to store. | -| listener | EventListener | Yes| Callback invoked to return the event.| - -**Table 2** EventListener +**Return value** -| Name| Description| +| Type| Description| | -------- | -------- | -| EventListener = (evt:  Object) => void | Event to store.| +| Promise<number> | Promise used to return the exit code of the child process.| **Example** ```js -process.on("data", (e)=>{ - console.log("data callback"); +let child = process.runCmd('ls'); +let result = child.wait(); +result.then(val=>{ + console.log("result = " + val); }) ``` -## process.off +### getOutput -off(type: string): boolean +getOutput(): Promise<Uint8Array> -Deletes the event stored by the user. +Obtains the standard output of the child process. **System API**: This is a system API. @@ -702,56 +792,57 @@ It is used only to test applications. **System capability**: SystemCapability.Utils.Lang -**Parameters** - -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| type | string | Yes| Type of the event to delete.| - **Return value** | Type| Description| | -------- | -------- | -| boolean | Returns **true** if the event is deleted; returns **false** otherwise.| +| Promise<Uint8Array> | Promise used to return the standard output in a Uint8Array.| **Example** ```js -process.on("data", (e)=>{ - console.log("data callback"); +let child = process.runCmd('ls'); +let result = child.wait(); +child.getOutput().then(val=>{ + console.log("child.getOutput = " + val); }) -let result = process.off("data"); ``` -## process.exit +### getErrorOutput -exit(code: number): void +getErrorOutput(): Promise<Uint8Array> -Terminates this process. +Obtains the standard error output of the child process. + +**System API**: This is a system API. -Exercise caution when using this API. +It is used only to test applications. **System capability**: SystemCapability.Utils.Lang -**Parameters** +**Return value** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| code | number | Yes| Exit code of the process.| +| Type| Description| +| -------- | -------- | +| Promise<Uint8Array> | Promise used to return the standard error output in a Uint8Array.| **Example** ```js -process.exit(0); +let child = process.runCmd('madir test.text'); +let result = child.wait(); +child.getErrorOutput().then(val=>{ + console.log("child.getErrorOutput= " + val); +}) ``` -## process.cwd +### close -cwd(): string +close(): void -Obtains the working directory of this process. +Closes the child process in running. **System API**: This is a system API. @@ -762,15 +853,16 @@ It is used only to test applications. **Example** ```js -let path = process.cwd(); +let child = process.runCmd('sleep 5; ls'); +child.close(); ``` -## process.chdir +### kill -chdir(dir: string): void +kill(signal: number | string): void -Changes the working directory of this process. +Sends a signal to the specified child process to terminate it. **System API**: This is a system API. @@ -782,60 +874,11 @@ It is used only to test applications. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| dir | string | Yes| Path| - -**Example** - -```js -process.chdir('/system'); -``` - - -## process.uptime - -uptime(): number - -Obtains the running time of this process. - -**System capability**: SystemCapability.Utils.Lang - -**Return value** - -| Type| Description| -| -------- | -------- | -| number | Running time of the process, in seconds.| - -**Example** - -```js -let time = process.uptime(); -``` - - -## process.kill - -kill(signal: number, pid: number): boolean - -Sends a signal to the specified process to terminate it. - -**System capability**: SystemCapability.Utils.Lang - -**Parameters** - -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| pid | number | Yes| PID of the process, to which the signal will be sent.| -| signal | number | Yes| Signal to send.| - -**Return value** - -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the signal is sent successfully; returns **false** otherwise.| +| signal | number \| string | Yes| Number or string to send.| **Example** ```js -let pres = process.pid -let result = process.kill(28, pres) +let child = process.runCmd('sleep 5; ls'); +child.kill(9); ``` -- GitLab