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

Come Correct with Wrapping

Browse source
This commit is contained in:
Paul Betts 2016-05-17 14:54:33 -07:00
parent bfb4867e10
commit dc86ec8ddd
1 changed files with 23 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/api/process.md
View file

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