Skip to content

Commit 579f01c

Browse files
rayw000BethGriggs
authored andcommitted
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]>
1 parent 789fef1 commit 579f01c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/api/v8.md

+6
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,10 @@ added: v8.0.0
333333

334334
Uses a [`DefaultSerializer`][] to serialize `value` into a buffer.
335335

336+
[`ERR_BUFFER_TOO_LARGE`][] will be thrown when trying to
337+
serialize a huge object which requires buffer
338+
larger than [`buffer.constants.MAX_LENGTH`][].
339+
336340
### `v8.deserialize(buffer)`
337341

338342
<!-- YAML
@@ -564,10 +568,12 @@ A subclass of [`Deserializer`][] corresponding to the format written by
564568
[`DefaultDeserializer`]: #class-v8defaultdeserializer
565569
[`DefaultSerializer`]: #class-v8defaultserializer
566570
[`Deserializer`]: #class-v8deserializer
571+
[`ERR_BUFFER_TOO_LARGE`]: errors.md#err_buffer_too_large
567572
[`Error`]: errors.md#class-error
568573
[`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-13.2/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4
569574
[`NODE_V8_COVERAGE`]: cli.md#node_v8_coveragedir
570575
[`Serializer`]: #class-v8serializer
576+
[`buffer.constants.MAX_LENGTH`]: buffer.md#bufferconstantsmax_length
571577
[`deserializer._readHostObject()`]: #deserializer_readhostobject
572578
[`deserializer.transferArrayBuffer()`]: #deserializertransferarraybufferid-arraybuffer
573579
[`serialize()`]: #v8serializevalue

0 commit comments

Comments
 (0)