mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Merge pull request #5526 from electron/process-stats

Browse source 
Process and System memory statistics API
This commit is contained in:
Cheng Zhao 2016-05-19 10:34:01 +00:00
commit 0bd3e28a05
2 changed files with 79 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/api/process.md
View file

@ -14,10 +14,10 @@ upstream node:
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`.
* `process.defaultApp` Boolean - When app is started by being passed as parameter
to the default app, this value is `true` in the main process, otherwise it is
`undefined`.
* `process.defaultApp` Boolean - When app is started by being passed as
parameter to the default app, this value is `true` in the main process,
otherwise it is `undefined`.
## Events
### Event: 'loaded'
@ -63,3 +63,34 @@ 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.
### getProcessMemoryInfo()
Return an object giving memory usage statistics about the current process. Note
that all statistics are reported in Kilobytes.
* `workingSetSize` - The amount of memory currently pinned to actual physical
RAM
* `peakWorkingSetSize` - The maximum amount of memory that has ever been pinned
to actual physical RAM
* `privateBytes` - The amount of memory not shared by other processes, such as
JS heap or HTML content.
* `sharedBytes` - The amount of memory shared between processes, typically
memory consumed by the Electron code itself
### getSystemMemoryInfo()
Return an object giving memory usage statistics about the entire system. Note
that all statistics are reported in Kilobytes.
* `total` - The total amount of physical memory in Kilobytes available to the
system
* `free` - The total amount of memory not being used by applications or disk
cache
On Windows / Linux:
* `swapTotal` - The total amount of swap memory in Kilobytes available to the
system
* `swapFree` - The free amount of swap memory in Kilobytes available to the
system