From 1623622073eebc6b61c2161c9e7ee4601d469fb4 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 17 May 2016 14:46:50 -0700 Subject: [PATCH] Dox --- docs/api/process.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/api/process.md b/docs/api/process.md index ec982d3..14b1c9b 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -17,6 +17,10 @@ upstream node: * `process.defaultApp` Boolean - When app is started by being passed as parameter to the default app, this value is `true` in the main process, otherwise it is `undefined`. +* `process.getSystemMemoryInfo` - Returns the amount of system memory and free + swap space +* `process.getProcessMemoryInfo` - Returns the amount of actual memory used by + Chromium for the current process. ## Events @@ -63,3 +67,26 @@ Causes the main thread of the current process hang. Sets the file descriptor soft limit to `maxDescriptors` or the OS hard limit, whichever is lower for the current process. + +### getProcessMemoryInfo() + +Return 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 RAM +* `peakWorkingSetSize` - 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 JS heap or HTML content. +* `sharedBytes` - The amount of memory shared between processes, typically memory consumed by the Electron code itself + +### getSystemMemoryInfo() + +Return 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 system +* `free` - 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 -- 2.7.4