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

denote return type on process memory info methods methods

Browse source
This commit is contained in:
Zeke Sikelianos 2016-07-14 16:10:19 -07:00
parent 595b827a13
commit 7700c5e249
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
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 Returns an object giving memory usage statistics about the current process. Note
that all statistics are reported in Kilobytes. 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. 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. 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. 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 memory consumed by the Electron code itself
### `process.getSystemMemoryInfo()` ### `process.getSystemMemoryInfo()`
@ -100,9 +100,9 @@ that all statistics are reported in Kilobytes.
Returns an object giving memory usage statistics about the entire system. Note Returns an object giving memory usage statistics about the entire system. Note
that 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 * `total` Integer - The total amount of physical memory in Kilobytes available to the
system. 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. cache.
* `swapTotal` Integer - The total amount of swap memory in Kilobytes available to the * `swapTotal` Integer - The total amount of swap memory in Kilobytes available to the
system. _Windows_ _Linux_ system. _Windows_ _Linux_