From 52b253677a96021739d4c31ab4e3a01c3464e6db Mon Sep 17 00:00:00 2001 From: Vse Mozhet Byt Date: Mon, 13 Feb 2017 04:49:35 +0200 Subject: doc: fix sorting in API references PR-URL: https://github.com/nodejs/node/pull/11331 Reviewed-By: James M Snell Reviewed-By: Sam Roberts --- doc/api/v8.md | 78 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 39 insertions(+), 39 deletions(-) (limited to 'doc/api/v8.md') diff --git a/doc/api/v8.md b/doc/api/v8.md index 8cec6bdfdf..528f8967e2 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -9,45 +9,6 @@ const v8 = require('v8'); *Note*: The APIs and implementation are subject to change at any time. -## v8.getHeapStatistics() - - -Returns an object with the following properties: - -* `total_heap_size` {number} -* `total_heap_size_executable` {number} -* `total_physical_size` {number} -* `total_available_size` {number} -* `used_heap_size` {number} -* `heap_size_limit` {number} -* `malloced_memory` {number} -* `peak_malloced_memory` {number} -* `does_zap_garbage` {number} - -`does_zap_garbage` is a 0/1 boolean, which signifies whether the `--zap_code_space` -option is enabled or not. This makes V8 overwrite heap garbage with a bit -pattern. The RSS footprint (resident memory set) gets bigger because it -continuously touches all heap pages and that makes them less likely to get -swapped out by the operating system. - -For example: - -```js -{ - total_heap_size: 7326976, - total_heap_size_executable: 4194304, - total_physical_size: 7326976, - total_available_size: 1152656, - used_heap_size: 3476208, - heap_size_limit: 1535115264, - malloced_memory: 16384, - peak_malloced_memory: 1127496, - does_zap_garbage: 0 -} -``` - ## v8.getHeapSpaceStatistics() + +Returns an object with the following properties: + +* `total_heap_size` {number} +* `total_heap_size_executable` {number} +* `total_physical_size` {number} +* `total_available_size` {number} +* `used_heap_size` {number} +* `heap_size_limit` {number} +* `malloced_memory` {number} +* `peak_malloced_memory` {number} +* `does_zap_garbage` {number} + +`does_zap_garbage` is a 0/1 boolean, which signifies whether the `--zap_code_space` +option is enabled or not. This makes V8 overwrite heap garbage with a bit +pattern. The RSS footprint (resident memory set) gets bigger because it +continuously touches all heap pages and that makes them less likely to get +swapped out by the operating system. + +For example: + +```js +{ + total_heap_size: 7326976, + total_heap_size_executable: 4194304, + total_physical_size: 7326976, + total_available_size: 1152656, + used_heap_size: 3476208, + heap_size_limit: 1535115264, + malloced_memory: 16384, + peak_malloced_memory: 1127496, + does_zap_garbage: 0 +} +``` + ## v8.setFlagsFromString(string)