Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 305c022

Browse filesBrowse files
rayw000targos
authored andcommitted
doc: describe buffer limit of v8.serialize
PR-URL: #40243 Fixes: #40059 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
1 parent 396342e commit 305c022
Copy full SHA for 305c022

File tree

Expand file treeCollapse file tree

1 file changed

+6
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+6
-0
lines changed
Open diff view settings
Collapse file

‎doc/api/v8.md‎

Copy file name to clipboardExpand all lines: doc/api/v8.md
+6Lines changed: 6 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,10 @@ added: v8.0.0
335335

336336
Uses a [`DefaultSerializer`][] to serialize `value` into a buffer.
337337

338+
[`ERR_BUFFER_TOO_LARGE`][] will be thrown when trying to
339+
serialize a huge object which requires buffer
340+
larger than [`buffer.constants.MAX_LENGTH`][].
341+
338342
### `v8.deserialize(buffer)`
339343

340344
<!-- YAML
@@ -566,10 +570,12 @@ A subclass of [`Deserializer`][] corresponding to the format written by
566570
[`DefaultDeserializer`]: #class-v8defaultdeserializer
567571
[`DefaultSerializer`]: #class-v8defaultserializer
568572
[`Deserializer`]: #class-v8deserializer
573+
[`ERR_BUFFER_TOO_LARGE`]: errors.md#err_buffer_too_large
569574
[`Error`]: errors.md#class-error
570575
[`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-13.2/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4
571576
[`NODE_V8_COVERAGE`]: cli.md#node_v8_coveragedir
572577
[`Serializer`]: #class-v8serializer
578+
[`buffer.constants.MAX_LENGTH`]: buffer.md#bufferconstantsmax_length
573579
[`deserializer._readHostObject()`]: #deserializer_readhostobject
574580
[`deserializer.transferArrayBuffer()`]: #deserializertransferarraybufferid-arraybuffer
575581
[`serialize()`]: #v8serializevalue

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.