diff options
author | Rich Trott <rtrott@gmail.com> | 2021-07-01 07:22:38 +0300 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2021-07-03 17:41:37 +0300 |
commit | 9b99037798914ebc0f5a3240a5ed6a8a6ffd1d89 (patch) | |
tree | 488718199f1b8d8d28bdb4351af7fc6639301e4a /doc/api | |
parent | 9ad96e2889bca11e4edd0bc0e628d78e0ab48c77 (diff) |
doc: move v8.stopCoverage() to expected location in doc
PR-URL: https://github.com/nodejs/node/pull/39212
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/v8.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/api/v8.md b/doc/api/v8.md index 41e4c745628..cdba51d8ddb 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -223,6 +223,19 @@ v8.setFlagsFromString('--trace_gc'); setTimeout(() => { v8.setFlagsFromString('--notrace_gc'); }, 60e3); ``` +## `v8.stopCoverage()` + +<!-- YAML +added: + - v15.1.0 + - v12.22.0 +--> + +The `v8.stopCoverage()` method allows the user to stop the coverage collection +started by [`NODE_V8_COVERAGE`][], so that V8 can release the execution count +records and optimize code. This can be used in conjunction with +[`v8.takeCoverage()`][] if the user wants to collect the coverage on demand. + ## `v8.takeCoverage()` <!-- YAML @@ -240,19 +253,6 @@ by [`NODE_V8_COVERAGE`][]. When the process is about to exit, one last coverage will still be written to disk unless [`v8.stopCoverage()`][] is invoked before the process exits. -## `v8.stopCoverage()` - -<!-- YAML -added: - - v15.1.0 - - v12.22.0 ---> - -The `v8.stopCoverage()` method allows the user to stop the coverage collection -started by [`NODE_V8_COVERAGE`][], so that V8 can release the execution count -records and optimize code. This can be used in conjunction with -[`v8.takeCoverage()`][] if the user wants to collect the coverage on demand. - ## `v8.writeHeapSnapshot([filename])` <!-- YAML added: v11.13.0 |