You are reading 13.0.1. See this page in 13.4.1.
process
Extends EventEmitter
A Node.js-compatible implementation of the core process module
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
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 22
arch
StringReturns 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 os.arch. Relates strongly to Titanium.Platform.architecture.
argv
Array<String>The 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 process.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.
The process.argv0 property stores a read-only copy of the original value of argv[0] passed when Node.js starts.
Value ""
channel
ObjectAlways undefined in Titanium.
Value "undefined"
config
ObjectAlways {} in Titanium.
connected
BooleanAlways false in Titanium.
Value false
debugPort
NumberThe port used by the debugger when enabled.
env
ObjectThis 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!
execArgv
Array<String>Always [] in Titanium.
execPath
StringAlways '' in Titanium.
exitCode
NumberUnused in Titanium.
Value "undefined"
noDeprecation
BooleanThe 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
NumberThe process.pid property returns the PID of the process. Always returns 0 in Titanium.
Value 0
platform
StringEquivalent to Titanium.Platform.osname
ppid
NumberThe process.ppid property returns the PID of the parent of the current process. Always returns 0 in Titanium.
Value 0
stderr
ObjectThe process.stderr property returns a stream connected to stderr.
stdout
ObjectThe process.stdout property returns a stream connected to stdout.
throwDeprecation
BooleanThe 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
title
StringEquivalent to Titanium.App.name
traceDeprecation
BooleanThe 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
version
StringEquivalent to Titanium.version
versions
ObjectAn object containing version information for included dependencies
Methods 26
No-op on Titanium
Inherited from EventEmitter
Alias for EventEmitter.on
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event listener/callback function |
This is not intended as user-facing API and will throw an Error if invoked.
This is unsupported on Titanium and will throw an Error if invoked.
Returns a dummy object with 0-ed out values.
Returns the value of __dirname on Titanium.
No-op on Titanium
This is unsupported on Titanium and will throw an Error if invoked.
Inherited from EventEmitter
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Returns true if the event had listeners, false otherwise.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| args? | any | Optional arguments to pass along to event listeners |
The 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 | Type | Description |
|---|---|---|
| warning | String | Error | The warning to emit. |
| options? | String | EmitWarningOptions | When 4 fields
|
| code? | String | A unique identifier for the warning instance being emitted. |
| ctor? | Function | When |
Inherited from EventEmitter
Returns an array listing the events for which the emitter has registered listeners.
This is unsupported on Titanium and will throw an Error if invoked.
Inherited from EventEmitter
Returns the current max listener value for the EventEmitter which is either set by EventEmitter.setMaxListeners or defaults to events.defaultMaxListeners.
Inherited from EventEmitter
Returns the number of listeners listening to the event named eventName.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
Inherited from EventEmitter
Returns a copy of the array of listeners for the event named eventName.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
Inherited from EventEmitter
Alias for EventEmitter.removeListener.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event listener/callback function |
Inherited from EventEmitter
Adds the listener function to the end of the listeners array for the event named eventName.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event listener/callback function |
Inherited from EventEmitter
Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event listener/callback function |
Inherited from EventEmitter
Adds the listener function to the beginning of the listeners array for the event named eventName.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event listener/callback function |
Inherited from EventEmitter
Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event listener/callback function |
Inherited from EventEmitter
Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
Inherited from EventEmitter
Removes all listeners, or those of the specified eventName.
| Parameters | Type | Description |
|---|---|---|
| eventName? | String | The event name |
Inherited from EventEmitter
Removes the specified listener from the listener array for the event named eventName.
| Parameters | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event listener/callback function |
Inherited from EventEmitter
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.
This is a useful default that helps finding memory leaks.
The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance.
The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
| Parameters | Type | Description |
|---|---|---|
| n | Number | new max listener count |
No-op on Titanium. Will always return 0.
The 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.
Events 4
Inherited from EventEmitter
The 'newListener' event is emitted after the listener is added.
| Event properties | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event handler function |
Inherited from EventEmitter
The 'removeListener' event is emitted after the listener is removed.
| Event properties | Type | Description |
|---|---|---|
| eventName | String | The event name |
| listener | Function | The event handler function |
The 'uncaughtException' event is emitted when an uncaught JavaScript exception bubbles all the way back to the event loop.
| Event properties | Type | Description |
|---|---|---|
| err | Error | The uncaught exception. |
The 'warning' event is emitted whenever Node.js emits a process warning.
| Event properties | Type | Description |
|---|---|---|
| warning | Error | The warning thrown. |