docs: process.getProcessMemoryInfo() returns a Promise (#16593)
* docs: process.getProcessMemoryInfo() returns a Promise * chore: bump electron-typescript-definitions to get Promise<T> fix
This commit is contained in:
parent
671533f7d2
commit
de1bacddd9
4 changed files with 141 additions and 316 deletions
|
@ -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
8
docs/api/structures/process-memory-info.md
Normal 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.
|
Loading…
Add table
Add a link
Reference in a new issue