summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2020-10-25 05:55:34 -0700
committerRich Trott <rtrott@gmail.com>2020-10-27 06:18:26 -0700
commit245ec6f5abebac189d442c872b43ee9a5e37ab5a (patch)
treed292d2e24a951abddbec76f308d9c2f147f5d3d5
parent34810e0141b36e4fc8b3f36e2a87382d5815e399 (diff)
downloadnode-new-245ec6f5abebac189d442c872b43ee9a5e37ab5a.tar.gz
doc,test: update v8 method doc and comment
Update documentation and test comment for v8.cachedDataVersionTag(). PR-URL: https://github.com/nodejs/node/pull/35795 Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
-rw-r--r--doc/api/v8.md13
-rw-r--r--test/parallel/test-v8-version-tag.js6
2 files changed, 14 insertions, 5 deletions
diff --git a/doc/api/v8.md b/doc/api/v8.md
index e0b2039264..4f72b16e01 100644
--- a/doc/api/v8.md
+++ b/doc/api/v8.md
@@ -18,11 +18,20 @@ added: v8.0.0
* Returns: {integer}
-Returns an integer representing a "version tag" derived from the V8 version,
-command-line flags and detected CPU features. This is useful for determining
+Returns an integer representing a version tag derived from the V8 version,
+command-line flags, and detected CPU features. This is useful for determining
whether a [`vm.Script`][] `cachedData` buffer is compatible with this instance
of V8.
+```js
+console.log(v8.cachedDataVersionTag()); // 3947234607
+// The value returned by v8.cachedDataVersionTag() is derived from the V8
+// version, command-line flags, and detected CPU features. Test that the value
+// does indeed update when flags are toggled.
+v8.setFlagsFromString('--allow_natives_syntax');
+console.log(v8.cachedDataVersionTag()); // 183726201
+```
+
## `v8.getHeapSpaceStatistics()`
<!-- YAML
added: v6.0.0
diff --git a/test/parallel/test-v8-version-tag.js b/test/parallel/test-v8-version-tag.js
index 22b0db0cd4..ec57b82fac 100644
--- a/test/parallel/test-v8-version-tag.js
+++ b/test/parallel/test-v8-version-tag.js
@@ -7,9 +7,9 @@ const versionTag1 = v8.cachedDataVersionTag();
assert.strictEqual(typeof versionTag1, 'number');
assert.strictEqual(v8.cachedDataVersionTag(), versionTag1);
-// The value of cachedDataVersionTag is derived from the command line flags and
-// detected CPU features. Test that the value does indeed update when flags
-// are toggled.
+// The value returned by v8.cachedDataVersionTag() is derived from the V8
+// version, command-line flags, and detected CPU features. Test that the value
+// does indeed update when flags are toggled.
v8.setFlagsFromString('--allow_natives_syntax');
const versionTag2 = v8.cachedDataVersionTag();