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

Dox

Browse source
This commit is contained in:
Paul Betts 2016-05-17 14:46:50 -07:00
parent ae2eec3efa
commit 1623622073
1 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/api/process.md
View file

@ -17,6 +17,10 @@ upstream node:
* `process.defaultApp` Boolean - When app is started by being passed as parameter * `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 to the default app, this value is `true` in the main process, otherwise it is
`undefined`. `undefined`.
* `process.getSystemMemoryInfo` - Returns the amount of system memory and free
swap space
* `process.getProcessMemoryInfo` - Returns the amount of actual memory used by
Chromium for the current process.
## Events ## Events
@ -63,3 +67,26 @@ Causes the main thread of the current process hang.
Sets the file descriptor soft limit to `maxDescriptors` or the OS hard Sets the file descriptor soft limit to `maxDescriptors` or the OS hard
limit, whichever is lower for the current process. 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