doc: describe buffer limit of v8.serialize

PR-URL: #40243 Fixes: #40059 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
nodejs · Oct 23, 2021 · 305c022 · 305c022
1 parent 396342e
commit 305c022
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/v8.md b/doc/api/v8.md
@@ -335,6 +335,10 @@ added: v8.0.0
 
 Uses a [`DefaultSerializer`][] to serialize `value` into a buffer.
 
+[`ERR_BUFFER_TOO_LARGE`][] will be thrown when trying to
+serialize a huge object which requires buffer
+larger than [`buffer.constants.MAX_LENGTH`][].
+
 ### `v8.deserialize(buffer)`
 
 <!-- YAML
@@ -566,10 +570,12 @@ A subclass of [`Deserializer`][] corresponding to the format written by
 [`DefaultDeserializer`]: #class-v8defaultdeserializer
 [`DefaultSerializer`]: #class-v8defaultserializer
 [`Deserializer`]: #class-v8deserializer
+[`ERR_BUFFER_TOO_LARGE`]: errors.md#err_buffer_too_large
 [`Error`]: errors.md#class-error
 [`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-13.2/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4
 [`NODE_V8_COVERAGE`]: cli.md#node_v8_coveragedir
 [`Serializer`]: #class-v8serializer
+[`buffer.constants.MAX_LENGTH`]: buffer.md#bufferconstantsmax_length
 [`deserializer._readHostObject()`]: #deserializer_readhostobject
 [`deserializer.transferArrayBuffer()`]: #deserializertransferarraybufferid-arraybuffer
 [`serialize()`]: #v8serializevalue