docs: process.getProcessMemoryInfo() returns a Promise

electron · Jan 29, 2019 · 54b95ad · 54b95ad
1 parent 940c4c0
commit 54b95ad
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/docs/api/process.md b/docs/api/process.md
@@ -171,14 +171,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.

diff --git a/docs/api/structures/process-memory-info.md b/docs/api/structures/process-memory-info.md
@@ -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.