process (fable-electron-docs-api)

process Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Main
Base Type: obj
All Interfaces: EventEmitter

⚠ Process Availability: Main ✔ | Renderer ✔ | Utility ❌ | Exported ✔

Extensions to process object.Process: Main, RendererElectron's process object is extended from the Node.js process object. It adds the following events, properties, and methods:### SandboxIn sandboxed renderers the process object contains only a subset of the APIs:* crash()* hang()* getCreationTime()* getHeapStatistics()* getBlinkMemoryInfo()* getProcessMemoryInfo()* getSystemMemoryInfo()* getSystemVersion()* getCPUUsage()* uptime()* argv* execPath* env* pid* arch* platform* sandboxed* contextIsolated* type* version* versions* mas* windowsStore* contextId

Static members

Static member	Description
`process.chrome` Full Usage: `process.chrome` Returns: `string`	A string representing Chrome's version string. Returns: `string`
`process.contextId` Full Usage: `process.contextId` Returns: `string`	A string (optional) representing a globally unique ID of the current JavaScript context. Each frame has its own JavaScript context. When contextIsolation is enabled, the isolated world also has a separate JavaScript context. This property is only available in the renderer process. Returns: `string`
`process.contextIsolated` Full Usage: `process.contextIsolated` Returns: `bool`	A boolean that indicates whether the current renderer context has contextIsolation enabled. It is undefined in the main process. Returns: `bool`
`process.crash ()` Full Usage: `process.crash ()` Modifiers: inline	Causes the main thread of the current process crash.
`process.defaultApp` Full Usage: `process.defaultApp` Returns: `bool`	A boolean. When the app is started by being passed as parameter to the default Electron executable, this property is true in the main process, otherwise it is undefined. For example when running the app with electron ., it is true, even if the app is packaged (isPackaged) is true. This can be useful to determine how many arguments will need to be sliced off from process.argv. Returns: `bool`
`process.electron` Full Usage: `process.electron` Returns: `string`	A string representing Electron's version string. Returns: `string`
`process.getBlinkMemoryInfo ()` Full Usage: `process.getBlinkMemoryInfo ()` Returns: `GetBlinkMemoryInfo` Modifiers: inline	allocated Integer - Size of all allocated objects in Kilobytes.* total Integer - 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. Returns: `GetBlinkMemoryInfo`
`process.getCPUUsage ()` Full Usage: `process.getCPUUsage ()` Returns: `CPUUsage` Modifiers: inline	Returns: `CPUUsage`
`process.getCreationTime ()` Full Usage: `process.getCreationTime ()` Returns: `Option<float>` Modifiers: inline	The number of milliseconds since epoch, or null if the information is unavailableIndicates 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: `Option<float>`
`process.getHeapStatistics ()` Full Usage: `process.getHeapStatistics ()` Returns: `GetHeapStatistics` Modifiers: inline	totalHeapSize Integer* totalHeapSizeExecutable Integer* totalPhysicalSize Integer* totalAvailableSize Integer* usedHeapSize Integer* heapSizeLimit Integer* mallocedMemory Integer* peakMallocedMemory Integer* doesZapGarbage booleanReturns an object with V8 heap statistics. Note that all statistics are reported in Kilobytes. Returns: `GetHeapStatistics`
`process.getProcessMemoryInfo ()` Full Usage: `process.getProcessMemoryInfo ()` Returns: `Promise<ProcessMemoryInfo>` Modifiers: inline	Resolves with a ProcessMemoryInfoReturns 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. private memory is more representative of the actual pre-compression memory usage of the process on macOS. Returns: `Promise<ProcessMemoryInfo>`
`process.getSystemMemoryInfo ()` Full Usage: `process.getSystemMemoryInfo ()` Returns: `GetSystemMemoryInfo` Modifiers: inline	total Integer - The total amount of physical memory in Kilobytes available to the system.* free Integer - The total amount of memory not being used by applications or disk cache.* fileBacked Integer macOS - The amount of memory that currently has been paged out to storage. Includes memory for file caches, network buffers, and other system services.* purgeable Integer macOS - The amount of memory that is marked as "purgeable". The system can reclaim it if memory pressure increases.* swapTotal Integer Windows Linux - The total amount of swap memory in Kilobytes available to the system.* swapFree Integer 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. Returns: `GetSystemMemoryInfo`
`process.getSystemVersion ()` Full Usage: `process.getSystemVersion ()` Returns: `string` Modifiers: inline	The version of the host operating system.Example:> [!NOTE] It returns the actual operating system version instead of kernel version on macOS unlike os.release(). Returns: `string`
`process.hang ()` Full Usage: `process.hang ()` Modifiers: inline	Causes the main thread of the current process hang.
`process.isMainFrame` Full Usage: `process.isMainFrame` Returns: `bool`	A boolean, true when the current renderer context is the "main" renderer frame. If you want the ID of the current frame you should use webFrame.routingId. Returns: `bool`
`process.mas` Full Usage: `process.mas` Returns: `bool`	A boolean. For Mac App Store build, this property is true, for other builds it is undefined. Returns: `bool`
`process.noAsar` Full Usage: `process.noAsar`	A boolean that controls ASAR support inside your application. Setting this to true will disable the support for asar archives in Node's built-in modules.
`process.noDeprecation` Full Usage: `process.noDeprecation`	A boolean that controls whether or not deprecation warnings are printed to stderr. Setting this to true will silence deprecation warnings. This property is used instead of the --no-deprecation command line flag.
`process.offLoaded handler` Full Usage: `process.offLoaded handler` Parameters: handler : `unit -> unit` Modifiers: inline	Emitted when Electron has loaded its internal initialization script and is beginning to load the web page or the main script. handler : `unit -> unit`
`process.onLoaded handler` Full Usage: `process.onLoaded handler` Parameters: handler : `unit -> unit` Modifiers: inline	Emitted when Electron has loaded its internal initialization script and is beginning to load the web page or the main script. handler : `unit -> unit`
`process.onceLoaded handler` Full Usage: `process.onceLoaded handler` Parameters: handler : `unit -> unit` Modifiers: inline	Emitted when Electron has loaded its internal initialization script and is beginning to load the web page or the main script. handler : `unit -> unit`
`process.parentPort` Full Usage: `process.parentPort`	A Electron.ParentPort property if this is a UtilityProcess (or null otherwise) allowing communication with the parent process.
`process.resourcesPath` Full Usage: `process.resourcesPath` Returns: `string`	A string representing the path to the resources directory. Returns: `string`
`process.sandboxed` Full Usage: `process.sandboxed` Returns: `bool`	A boolean. When the renderer process is sandboxed, this property is true, otherwise it is undefined. Returns: `bool`
`process.setFdLimit maxDescriptors` Full Usage: `process.setFdLimit maxDescriptors` Parameters: maxDescriptors : `int` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ✔ \| MAS ❌ Sets the file descriptor soft limit to maxDescriptors or the OS hard limit, whichever is lower for the current process. maxDescriptors : `int`
`process.takeHeapSnapshot filePath` Full Usage: `process.takeHeapSnapshot filePath` Parameters: filePath : `string` Returns: `bool` Modifiers: inline	Indicates whether the snapshot has been created successfully.Takes a V8 heap snapshot and saves it to filePath. filePath : `string` Returns: `bool`
`process.throwDeprecation` Full Usage: `process.throwDeprecation`	A 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.
`process.traceDeprecation` Full Usage: `process.traceDeprecation`	A boolean that controls whether or not deprecations printed to stderr include their stack trace. Setting this to true will print stack traces for deprecations. This property is instead of the --trace-deprecation command line flag.
`process.traceProcessWarnings` Full Usage: `process.traceProcessWarnings`	A boolean that controls whether or not process warnings printed to stderr include their stack trace. Setting this to true will print stack traces for process warnings (including deprecations). This property is instead of the --trace-warnings command line flag.
`process.type` Full Usage: `process.type` Returns: `Type`	A string representing the current process's type, can be:* browser - The main process* renderer - A renderer process* service-worker - In a service worker* worker - In a web worker* utility - In a node process launched as a service Returns: `Type`
`process.windowsStore` Full Usage: `process.windowsStore` Returns: `bool`	A boolean. If the app is running as a Windows Store app (appx), this property is true, for otherwise it is undefined. Returns: `bool`