electron/docs/api/process.md
Cheng Zhao 096b948570 Merge pull request #5249 from electron/api-summaries
create a one-liner description for each API
2016-04-24 13:50:17 +09:00

1.7 KiB

process

Get information about the running application process.

The process object in Electron has the following differences from the one in upstream node:

  • process.type String - Process's type, can be browser (i.e. main process) or renderer.
  • process.versions['electron'] String - Version of Electron.
  • process.versions['chrome'] String - Version of Chromium.
  • process.resourcesPath String - Path to JavaScript source code.
  • process.mas Boolean - For Mac App Store build, this value is true, for other builds it is undefined.
  • process.windowsStore Boolean - If the app is running as a Windows Store app (appx), this value is true, for other builds it is undefined.

Events

Event: 'loaded'

Emitted when Electron has loaded its internal initialization script and is beginning to load the web page or the main script.

It can be used by the preload script to add removed Node global symbols back to the global scope when node integration is turned off:

// preload.js
var _setImmediate = setImmediate;
var _clearImmediate = clearImmediate;
process.once('loaded', function() {
  global.setImmediate = _setImmediate;
  global.clearImmediate = _clearImmediate;
});

Properties

process.noAsar

Setting this to true can disable the support for asar archives in Node's built-in modules.

Methods

The process object has the following method:

process.crash()

Causes the main thread of the current process crash.

process.hang()

Causes the main thread of the current process hang.

process.setFdLimit(maxDescriptors) OS X Linux

  • maxDescriptors Integer

Sets the file descriptor soft limit to maxDescriptors or the OS hard limit, whichever is lower for the current process.