diff --git a/doc/api/process.md b/doc/api/process.md index d15d41d8f0bb5a..eb1e388fc6eaea 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1573,26 +1573,19 @@ changes: * `external` {integer} * `arrayBuffers` {integer} -The `process.memoryUsage()` method returns an object describing the memory usage -of the Node.js process measured in bytes. - -For example, the code: +Returns an object describing the memory usage of the Node.js process measured in +bytes. ```js console.log(process.memoryUsage()); -``` - -Will generate: - - -```js -{ - rss: 4935680, - heapTotal: 1826816, - heapUsed: 650472, - external: 49879, - arrayBuffers: 9386 -} +// Prints: +// { +// rss: 4935680, +// heapTotal: 1826816, +// heapUsed: 650472, +// external: 49879, +// arrayBuffers: 9386 +// } ``` * `heapTotal` and `heapUsed` refer to V8's memory usage. @@ -1610,8 +1603,8 @@ Will generate: When using [`Worker`][] threads, `rss` will be a value that is valid for the entire process, while the other fields will only refer to the current thread. -The `process.memoryUsage()` method iterate over each page to gather -informations about memory usage which can be slow depending on the +The `process.memoryUsage()` method iterates over each page to gather +information about memory usage which might be slow depending on the program memory allocations. ## `process.memoryUsage.rss()` @@ -1628,7 +1621,8 @@ The Resident Set Size, is the amount of space occupied in the main memory device (that is a subset of the total allocated memory) for the process, including all C++ and JavaScript objects and code. -This is the same value as the one returned by `process.memoryUsage()`. +This is the same value as the `rss` property provided by `process.memoryUsage()` +but `process.memoryUsage.rss()` is faster. ```js console.log(process.memoryUsage.rss());