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

Merge pull request #6511 from electron/more-docs-cleanup

Browse source 
Clean up API Docs
This commit is contained in:
Cheng Zhao 2016-07-16 09:57:04 +09:00 committed by GitHub
commit 08491e1ceb
1 changed files with 10 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/api/process.md
View file

@ -86,13 +86,13 @@ limit, whichever is lower for the current process.
Returns 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
* `workingSetSize` Integer - The amount of memory currently pinned to actual physical
RAM.
* `peakWorkingSetSize` - The maximum amount of memory that has ever been pinned
* `peakWorkingSetSize` Integer - 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
* `privateBytes` Integer - 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
* `sharedBytes` Integer - The amount of memory shared between processes, typically
memory consumed by the Electron code itself
### `process.getSystemMemoryInfo()`
@ -100,14 +100,11 @@ that all statistics are reported in Kilobytes.
Returns 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
* `total` Integer - 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
* `free` Integer - 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.
* `swapTotal` Integer - The total amount of swap memory in Kilobytes available to the
system. _Windows_ _Linux_
* `swapFree` Integer - The free amount of swap memory in Kilobytes available to the
system. _Windows_ _Linux_