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

docs: process.getProcessMemoryInfo() returns a Promise (#16593)

Browse source 
* docs: process.getProcessMemoryInfo() returns a Promise
* chore: bump electron-typescript-definitions to get Promise<T> fix
This commit is contained in:
Milan Burda 2019-03-20 17:26:57 +01:00 • committed by Alexey Kuzmin
parent 671533f7d2
commit de1bacddd9
4 changed files with 141 additions and 316 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/api/process.md
View file

@ -172,14 +172,7 @@ Returns an object with V8 heap statistics. Note that all statistics are reported
### `process.getProcessMemoryInfo()`
Returns `Object`:
* `residentSet` Integer _Linux_ and _Windows_ - The amount of memory
currently pinned to actual physical RAM in Kilobytes.
* `private` Integer - The amount of memory not shared by other processes, such as
JS heap or HTML content in Kilobytes.
* `shared` Integer - The amount of memory shared between processes, typically
memory consumed by the Electron code itself in Kilobytes.
Returns `Promise<ProcessMemoryInfo>` - Resolves with a [ProcessMemoryInfo](structures/process-memory-info.md)
Returns an object giving memory usage statistics about the current process. Note
that all statistics are reported in Kilobytes.

8
docs/api/structures/process-memory-info.md Normal file
View file

@ -0,0 +1,8 @@
# ProcessMemoryInfo Object
* `residentSet` Integer _Linux_ and _Windows_ - The amount of memory
currently pinned to actual physical RAM in Kilobytes.
* `private` Integer - The amount of memory not shared by other processes, such as
JS heap or HTML content in Kilobytes.
* `shared` Integer - The amount of memory shared between processes, typically
memory consumed by the Electron code itself in Kilobytes.