diff options
| author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-11 21:07:14 +0300 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-12 03:18:01 +0300 |
| commit | df5d41bf93a304af4159398d0d9f44f0cba4ac94 (patch) | |
| tree | 83970afaa89bf7328b7491a680a62e2acf988a40 /doc/api/v8.md | |
| parent | 068c001dee01e8ac7401e97249c5f61215aed233 (diff) | |
| download | android-node-v8-df5d41bf93a304af4159398d0d9f44f0cba4ac94.tar.gz android-node-v8-df5d41bf93a304af4159398d0d9f44f0cba4ac94.tar.bz2 android-node-v8-df5d41bf93a304af4159398d0d9f44f0cba4ac94.zip | |
doc: add and unify even more return values
PR-URL: https://github.com/nodejs/node/pull/19955
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/v8.md')
| -rw-r--r-- | doc/api/v8.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/v8.md b/doc/api/v8.md index 9f9ad8ae51..74c7f23f9d 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -16,6 +16,8 @@ The APIs and implementation are subject to change at any time. 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 whether a [`vm.Script`][] `cachedData` buffer is compatible with this instance @@ -30,6 +32,8 @@ changes: description: Support values exceeding the 32-bit unsigned integer range. --> +* Returns: {Object[]} + Returns statistics about the V8 heap spaces, i.e. the segments which make up the V8 heap. Neither the ordering of heap spaces, nor the availability of a heap space can be guaranteed as the statistics are provided via the V8 @@ -96,6 +100,8 @@ changes: description: Support values exceeding the 32-bit unsigned integer range. --> +* Returns: {Object} + Returns an object with the following properties: * `total_heap_size` {number} @@ -204,6 +210,8 @@ This throws an error if `value` cannot be serialized. #### serializer.releaseBuffer() +* Returns: {Buffer} + Returns the stored internal buffer. This serializer should not be used once the buffer is released. Calling this method results in undefined behavior if a previous write has failed. |