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

Document the return values of all methods in the docs

Browse source
This commit is contained in:
Samuel Attard 2016-09-25 12:59:30 +13:00 • committed by Samuel Attard
parent bf88fe32fd
commit d2a701a465
22 changed files with 276 additions and 175 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/api/process.md
View file

@ -83,9 +83,7 @@ limit, whichever is lower for the current process.
### `process.getProcessMemoryInfo()`
Returns an object giving memory usage statistics about the current process. Note
that all statistics are reported in Kilobytes.
Returns `Object`:
* `workingSetSize` Integer - The amount of memory currently pinned to actual physical
RAM.
* `peakWorkingSetSize` Integer - The maximum amount of memory that has ever been pinned
@ -95,11 +93,12 @@ that all statistics are reported in Kilobytes.
* `sharedBytes` Integer - The amount of memory shared between processes, typically
memory consumed by the Electron code itself
### `process.getSystemMemoryInfo()`
Returns an object giving memory usage statistics about the entire system. Note
Returns an object giving memory usage statistics about the current process. Note
that all statistics are reported in Kilobytes.
### `process.getSystemMemoryInfo()`
Returns `Object`:
* `total` Integer - The total amount of physical memory in Kilobytes available to the
system.
* `free` Integer - The total amount of memory not being used by applications or disk
@ -108,3 +107,6 @@ that all statistics are reported in Kilobytes.
system. _Windows_ _Linux_
* `swapFree` Integer - The free amount of swap memory in Kilobytes available to the
system. _Windows_ _Linux_
Returns an object giving memory usage statistics about the entire system. Note
that all statistics are reported in Kilobytes.