Extensions to process object.
process object is extended from the
It adds the following events, properties, and methods:
In sandboxed renderers the
process object contains only a subset of the APIs:
Emitted when Electron has loaded its internal initialization script and is beginning to load the web page or the main script.
Boolean. When app is started by being passed as parameter to the default app, this
true in the main process, otherwise it is
true when the current renderer context is the "main" renderer
frame. If you want the ID of the current frame you should use
Boolean. For Mac App Store build, this property is
true, for other builds it is
Boolean that controls ASAR support inside your application. Setting this to
will disable the support for
asar archives in Node's built-in modules.
Boolean that controls whether or not deprecation warnings are printed to
Setting this to
true will silence deprecation warnings. This property is used
instead of the
--no-deprecation command line flag.
String representing the path to the resources directory.
Boolean. When the renderer process is sandboxed, this property is
otherwise it is
Boolean that indicates whether the current renderer context has
undefined in the main process.
Boolean that controls whether or not deprecation warnings will be thrown as
exceptions. Setting this to
true will throw errors for deprecations. This
property is used instead of the
--throw-deprecation command line flag.
Boolean that controls whether or not deprecations printed to
their stack trace. Setting this to
true will print stack traces for deprecations.
This property is instead of the
--trace-deprecation command line flag.
Boolean that controls whether or not process warnings printed to
their stack trace. Setting this to
true will print stack traces for process warnings
(including deprecations). This property is instead of the
String representing the current process's type, can be:
browser- The main process
renderer- A renderer process
worker- In a web worker
String representing Chrome's version string.
String representing Electron's version string.
Boolean. If the app is running as a Windows Store app (appx), this property is
for otherwise it is
This property is only available in the renderer process.
process object has the following methods:
Causes the main thread of the current process crash.
Number | null - The number of milliseconds since epoch, or
null if the information is unavailable
Indicates the creation time of the application. The time is represented as number of milliseconds since epoch. It returns null if it is unable to get the process creation time.
Returns an object with V8 heap statistics. Note that all statistics are reported in Kilobytes.
allocatedInteger - Size of all allocated objects in Kilobytes.
markedInteger - Size of all marked objects in Kilobytes.
totalInteger - Total allocated space in Kilobytes.
Returns an object with Blink memory information. It can be useful for debugging rendering / DOM related memory issues. Note that all values are reported in Kilobytes.
Promise<ProcessMemoryInfo> - Resolves with a ProcessMemoryInfo
Returns an object giving memory usage statistics about the current process. Note that all statistics are reported in Kilobytes. This api should be called after app ready.
Chromium does not provide
residentSet value for macOS. This is because macOS
performs in-memory compression of pages that haven't been recently used. As a
result the resident set size value is not what one would expect.
is more representative of the actual pre-compression memory usage of the process
totalInteger - The total amount of physical memory in Kilobytes available to the system.
freeInteger - The total amount of memory not being used by applications or disk cache.
swapTotalInteger Windows Linux - The total amount of swap memory in Kilobytes available to the system.
swapFreeInteger Windows Linux - The free amount of swap memory in Kilobytes available to the system.
Returns an object giving memory usage statistics about the entire system. Note that all statistics are reported in Kilobytes.
String - The version of the host operating system.
const version = process.getSystemVersion() console.log(version) // On macOS -> '10.13.6' // On Windows -> '10.0.17763' // On Linux -> '4.15.0-45-generic'
Note: It returns the actual operating system version instead of kernel version on macOS unlike
filePathString - Path to the output file.
Boolean - Indicates whether the snapshot has been created successfully.
Takes a V8 heap snapshot and saves it to
Causes the main thread of the current process hang.
Sets the file descriptor soft limit to
maxDescriptors or the OS hard
limit, whichever is lower for the current process.