Titanium Mobile # process
A Node.js-compatible implementation of the core process module
8.1.0
8.1.0
9.2.0NOTE
This is an abstract type. Any object of this structure can be used where this type is used.
# Overview
Titanium provides a number of shims and ports of core Node.js module functionality.
This module is intended to provide a Node-compatible port of the process core module.
More details on the Node.js API can be found in their process module documentation (opens new window)
Note that this particular shim has many unimplemented, no-op, or unsupported APIs and events.
The process object is a global that provides information about, and control over, the current Node.js process. As a global, it is always available to Node.js applications without using require(). It can also be explicitly accessed using require():
const process = require('process');
# Properties
# arch
8.1.0 8.1.0 9.2.0Returns the operating system CPU architecture for which the binary was compiled. Possible values are return 'arm', 'arm64', 'ia32', 'x64', 'mips', and 'unknown'.
The return value is equivalent to arch. Relates strongly to architecture.
# argv
8.1.0 8.1.0 9.2.0The process.argv property returns an array containing the command-line arguments passed when the Node.js process was launched.
The first element will be process.execPath. See argv0 if access to the original value of argv[0] is needed.
The second element will be the path to the JavaScript file being executed.
The remaining elements will be any additional command-line arguments.
# argv0 READONLY
8.1.0 8.1.0 9.2.0The process.argv0 property stores a read-only copy of the original value of argv[0] passed when Node.js starts.
# env
8.1.0 8.1.0 9.2.0This is an object whose keys are environment variable names and whose values are the related environmnet variable values.
In Titanium, we will pass along environment variables from the system/CLI to the app for 'development' builds,
but will not do so for 'production' builds!
# noDeprecation
8.1.0 8.1.0 9.2.0The process.noDeprecation property indicates whether the --no-deprecation flag is set on the current Node.js process. See the documentation for the 'warning' event and the emitWarning() method for more information about this flag's behavior.
Default: false
# pid
8.1.0 8.1.0 9.2.0The process.pid property returns the PID of the process. Always returns 0 in Titanium.
# ppid
8.1.0 8.1.0 9.2.0The process.ppid property returns the PID of the parent of the current process. Always returns 0 in Titanium.
# stderr
8.1.0 8.1.0 9.2.0The process.stderr property returns a stream connected to stderr.
# stdout
8.1.0 8.1.0 9.2.0The process.stdout property returns a stream connected to stdout.
# throwDeprecation
8.1.0 8.1.0 9.2.0The initial value of process.throwDeprecation indicates whether the --throw-deprecation flag is set on the current Node.js process. process.throwDeprecation is mutable, so whether or not deprecation warnings result in errors may be altered at runtime. See the documentation for the 'warning' event and the emitWarning() method for more information.
Default: false
# traceDeprecation
8.1.0 8.1.0 9.2.0The process.traceDeprecation property indicates whether the --trace-deprecation flag is set on the current Node.js process. See the documentation for the 'warning' event and the emitWarning() method for more information about this flag's behavior.
Default: false
# versions
8.1.0 8.1.0 9.2.0An object containing version information for included dependencies
# Methods
# binding
8.1.0 8.1.0 9.2.0This is not intended as user-facing API and will throw an Error if invoked.
Returns
- Type
- void
# chdir
8.1.0 8.1.0 9.2.0This is unsupported on Titanium and will throw an Error if invoked.
Returns
- Type
- void
# cpuUsage
8.1.0 8.1.0 9.2.0Returns a dummy object with 0-ed out values.
Returns
- Type
- Object
# cwd
8.1.0 8.1.0 9.2.0Returns the value of __dirname on Titanium.
Returns
- Type
- String
# dlopen
8.1.0 8.1.0 9.2.0This is unsupported on Titanium and will throw an Error if invoked.
Returns
- Type
- void
# emitWarning
8.1.0 8.1.0 9.2.0The process.emitWarning() method can be used to emit custom or application specific process warnings. These can be listened for by adding a handler to the 'warning' event.
Parameters
| Name | Type | Description |
|---|---|---|
warning | String | Error | The warning to emit. |
options | String | EmitWarningOptions | When |
code | String | A unique identifier for the warning instance being emitted. |
ctor | Function | When |
Returns
- Type
- void
# exit
8.1.0 8.1.0 9.2.0This is unsupported on Titanium and will throw an Error if invoked.
Returns
- Type
- void
# umask
8.1.0 8.1.0 9.2.0No-op on Titanium. Will always return 0.
Returns
- Type
- Number
# uptime
8.1.0 8.1.0 9.2.0The process.uptime() method returns the number of seconds the current Node.js process has been running.
The return value includes fractions of a second. Use Math.floor() to get whole seconds.
Returns
- Type
- Number
# Events
# uncaughtException
8.1.0 8.1.0 9.2.0The 'uncaughtException' event is emitted when an uncaught JavaScript exception bubbles all the way back to the event loop.
Properties
| Name | Type | Description |
|---|---|---|
| err | Error | The uncaught exception. |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# warning
8.1.0 8.1.0 9.2.0The 'warning' event is emitted whenever Node.js emits a process warning.
Properties
| Name | Type | Description |
|---|---|---|
| warning | Error | The warning thrown. |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |