@@ -11,7 +11,7 @@ const v8 = require('v8');
11
11
12
12
The APIs and implementation are subject to change at any time.
13
13
14
- ## v8.cachedDataVersionTag()
14
+ ## ` v8.cachedDataVersionTag() `
15
15
<!-- YAML
16
16
added: v8.0.0
17
17
-->
@@ -23,7 +23,7 @@ command line flags and detected CPU features. This is useful for determining
23
23
whether a [ ` vm.Script ` ] [ ] ` cachedData ` buffer is compatible with this instance
24
24
of V8.
25
25
26
- ## v8.getHeapSpaceStatistics()
26
+ ## ` v8.getHeapSpaceStatistics() `
27
27
<!-- YAML
28
28
added: v6.0.0
29
29
changes:
@@ -88,7 +88,7 @@ The value returned is an array of objects containing the following properties:
88
88
]
89
89
```
90
90
91
- ## v8.getHeapSnapshot()
91
+ ## ` v8.getHeapSnapshot() `
92
92
<!-- YAML
93
93
added: v11.13.0
94
94
-->
@@ -106,7 +106,7 @@ const stream = v8.getHeapSnapshot();
106
106
stream .pipe (process .stdout );
107
107
```
108
108
109
- ## v8.getHeapStatistics()
109
+ ## ` v8.getHeapStatistics() `
110
110
<!-- YAML
111
111
added: v1.0.0
112
112
changes:
@@ -166,7 +166,7 @@ being non-zero indicates a potential memory leak.
166
166
}
167
167
```
168
168
169
- ## v8.getHeapCodeStatistics()
169
+ ## ` v8.getHeapCodeStatistics() `
170
170
<!-- YAML
171
171
added: v12.8.0
172
172
-->
@@ -188,7 +188,7 @@ Returns an object with the following properties:
188
188
}
189
189
```
190
190
191
- ## v8.setFlagsFromString(flags)
191
+ ## ` v8.setFlagsFromString(flags) `
192
192
<!-- YAML
193
193
added: v1.0.0
194
194
-->
@@ -212,7 +212,7 @@ v8.setFlagsFromString('--trace_gc');
212
212
setTimeout (() => { v8 .setFlagsFromString (' --notrace_gc' ); }, 60e3 );
213
213
```
214
214
215
- ## v8.writeHeapSnapshot(\ [ filename\] )
215
+ ## ` v8.writeHeapSnapshot([filename]) `
216
216
<!-- YAML
217
217
added: v11.13.0
218
218
-->
@@ -270,7 +270,7 @@ The serialization API provides means of serializing JavaScript values in a way
270
270
that is compatible with the [ HTML structured clone algorithm] [ ] .
271
271
The format is backward-compatible (i.e. safe to store to disk).
272
272
273
- ### v8.serialize(value)
273
+ ### ` v8.serialize(value) `
274
274
<!-- YAML
275
275
added: v8.0.0
276
276
-->
@@ -280,7 +280,7 @@ added: v8.0.0
280
280
281
281
Uses a [ ` DefaultSerializer ` ] [ ] to serialize ` value ` into a buffer.
282
282
283
- ### v8.deserialize(buffer)
283
+ ### ` v8.deserialize(buffer) `
284
284
<!-- YAML
285
285
added: v8.0.0
286
286
-->
@@ -290,19 +290,19 @@ added: v8.0.0
290
290
Uses a [ ` DefaultDeserializer ` ] [ ] with default options to read a JS value
291
291
from a buffer.
292
292
293
- ### class: v8.Serializer
293
+ ### Class: ` v8.Serializer `
294
294
<!-- YAML
295
295
added: v8.0.0
296
296
-->
297
297
298
- #### new Serializer()
298
+ #### ` new Serializer() `
299
299
Creates a new ` Serializer ` object.
300
300
301
- #### serializer.writeHeader()
301
+ #### ` serializer.writeHeader() `
302
302
303
303
Writes out a header, which includes the serialization format version.
304
304
305
- #### serializer.writeValue(value)
305
+ #### ` serializer.writeValue(value) `
306
306
307
307
* ` value ` {any}
308
308
@@ -311,15 +311,15 @@ internal buffer.
311
311
312
312
This throws an error if ` value ` cannot be serialized.
313
313
314
- #### serializer.releaseBuffer()
314
+ #### ` serializer.releaseBuffer() `
315
315
316
316
* Returns: {Buffer}
317
317
318
318
Returns the stored internal buffer. This serializer should not be used once
319
319
the buffer is released. Calling this method results in undefined behavior
320
320
if a previous write has failed.
321
321
322
- #### serializer.transferArrayBuffer(id, arrayBuffer)
322
+ #### ` serializer.transferArrayBuffer(id, arrayBuffer) `
323
323
324
324
* ` id ` {integer} A 32-bit unsigned integer.
325
325
* ` arrayBuffer ` {ArrayBuffer} An ` ArrayBuffer ` instance.
@@ -328,37 +328,37 @@ Marks an `ArrayBuffer` as having its contents transferred out of band.
328
328
Pass the corresponding ` ArrayBuffer ` in the deserializing context to
329
329
[ ` deserializer.transferArrayBuffer() ` ] [ ] .
330
330
331
- #### serializer.writeUint32(value)
331
+ #### ` serializer.writeUint32(value) `
332
332
333
333
* ` value ` {integer}
334
334
335
335
Write a raw 32-bit unsigned integer.
336
336
For use inside of a custom [ ` serializer._writeHostObject() ` ] [ ] .
337
337
338
- #### serializer.writeUint64(hi, lo)
338
+ #### ` serializer.writeUint64(hi, lo) `
339
339
340
340
* ` hi ` {integer}
341
341
* ` lo ` {integer}
342
342
343
343
Write a raw 64-bit unsigned integer, split into high and low 32-bit parts.
344
344
For use inside of a custom [ ` serializer._writeHostObject() ` ] [ ] .
345
345
346
- #### serializer.writeDouble(value)
346
+ #### ` serializer.writeDouble(value) `
347
347
348
348
* ` value ` {number}
349
349
350
350
Write a JS ` number ` value.
351
351
For use inside of a custom [ ` serializer._writeHostObject() ` ] [ ] .
352
352
353
- #### serializer.writeRawBytes(buffer)
353
+ #### ` serializer.writeRawBytes(buffer) `
354
354
355
355
* ` buffer ` {Buffer|TypedArray|DataView}
356
356
357
357
Write raw bytes into the serializer’s internal buffer. The deserializer
358
358
will require a way to compute the length of the buffer.
359
359
For use inside of a custom [ ` serializer._writeHostObject() ` ] [ ] .
360
360
361
- #### serializer.\ _ writeHostObject(object)
361
+ #### ` serializer._writeHostObject(object) `
362
362
363
363
* ` object ` {Object}
364
364
@@ -369,7 +369,7 @@ exception should be thrown.
369
369
This method is not present on the ` Serializer ` class itself but can be provided
370
370
by subclasses.
371
371
372
- #### serializer.\ _ getDataCloneError(message)
372
+ #### ` serializer._getDataCloneError(message) `
373
373
374
374
* ` message ` {string}
375
375
@@ -379,7 +379,7 @@ object can not be cloned.
379
379
This method defaults to the [ ` Error ` ] [ ] constructor and can be overridden on
380
380
subclasses.
381
381
382
- #### serializer.\ _ getSharedArrayBufferId(sharedArrayBuffer)
382
+ #### ` serializer._getSharedArrayBufferId(sharedArrayBuffer) `
383
383
384
384
* ` sharedArrayBuffer ` {SharedArrayBuffer}
385
385
@@ -394,36 +394,36 @@ If the object cannot be serialized, an exception should be thrown.
394
394
This method is not present on the ` Serializer ` class itself but can be provided
395
395
by subclasses.
396
396
397
- #### serializer.\ _ setTreatArrayBufferViewsAsHostObjects(flag)
397
+ #### ` serializer._setTreatArrayBufferViewsAsHostObjects(flag) `
398
398
399
399
* ` flag ` {boolean} ** Default:** ` false `
400
400
401
401
Indicate whether to treat ` TypedArray ` and ` DataView ` objects as
402
402
host objects, i.e. pass them to [ ` serializer._writeHostObject() ` ] [ ] .
403
403
404
- ### class: v8.Deserializer
404
+ ### Class: ` v8.Deserializer `
405
405
<!-- YAML
406
406
added: v8.0.0
407
407
-->
408
408
409
- #### new Deserializer(buffer)
409
+ #### ` new Deserializer(buffer) `
410
410
411
411
* ` buffer ` {Buffer|TypedArray|DataView} A buffer returned by
412
412
[ ` serializer.releaseBuffer() ` ] [ ] .
413
413
414
414
Creates a new ` Deserializer ` object.
415
415
416
- #### deserializer.readHeader()
416
+ #### ` deserializer.readHeader() `
417
417
418
418
Reads and validates a header (including the format version).
419
419
May, for example, reject an invalid or unsupported wire format. In that case,
420
420
an ` Error ` is thrown.
421
421
422
- #### deserializer.readValue()
422
+ #### ` deserializer.readValue() `
423
423
424
424
Deserializes a JavaScript value from the buffer and returns it.
425
425
426
- #### deserializer.transferArrayBuffer(id, arrayBuffer)
426
+ #### ` deserializer.transferArrayBuffer(id, arrayBuffer) `
427
427
428
428
* ` id ` {integer} A 32-bit unsigned integer.
429
429
* ` arrayBuffer ` {ArrayBuffer|SharedArrayBuffer} An ` ArrayBuffer ` instance.
@@ -433,37 +433,37 @@ Pass the corresponding `ArrayBuffer` in the serializing context to
433
433
[ ` serializer.transferArrayBuffer() ` ] [ ] (or return the ` id ` from
434
434
[ ` serializer._getSharedArrayBufferId() ` ] [ ] in the case of ` SharedArrayBuffer ` s).
435
435
436
- #### deserializer.getWireFormatVersion()
436
+ #### ` deserializer.getWireFormatVersion() `
437
437
438
438
* Returns: {integer}
439
439
440
440
Reads the underlying wire format version. Likely mostly to be useful to
441
441
legacy code reading old wire format versions. May not be called before
442
442
` .readHeader() ` .
443
443
444
- #### deserializer.readUint32()
444
+ #### ` deserializer.readUint32() `
445
445
446
446
* Returns: {integer}
447
447
448
448
Read a raw 32-bit unsigned integer and return it.
449
449
For use inside of a custom [ ` deserializer._readHostObject() ` ] [ ] .
450
450
451
- #### deserializer.readUint64()
451
+ #### ` deserializer.readUint64() `
452
452
453
453
* Returns: {integer[ ] }
454
454
455
455
Read a raw 64-bit unsigned integer and return it as an array ` [hi, lo] `
456
456
with two 32-bit unsigned integer entries.
457
457
For use inside of a custom [ ` deserializer._readHostObject() ` ] [ ] .
458
458
459
- #### deserializer.readDouble()
459
+ #### ` deserializer.readDouble() `
460
460
461
461
* Returns: {number}
462
462
463
463
Read a JS ` number ` value.
464
464
For use inside of a custom [ ` deserializer._readHostObject() ` ] [ ] .
465
465
466
- #### deserializer.readRawBytes(length)
466
+ #### ` deserializer.readRawBytes(length) `
467
467
468
468
* ` length ` {integer}
469
469
* Returns: {Buffer}
@@ -473,7 +473,7 @@ must correspond to the length of the buffer that was passed to
473
473
[ ` serializer.writeRawBytes() ` ] [ ] .
474
474
For use inside of a custom [ ` deserializer._readHostObject() ` ] [ ] .
475
475
476
- #### deserializer.\ _ readHostObject()
476
+ #### ` deserializer._readHostObject() `
477
477
478
478
This method is called to read some kind of host object, i.e. an object that is
479
479
created by native C++ bindings. If it is not possible to deserialize the data,
@@ -482,7 +482,7 @@ a suitable exception should be thrown.
482
482
This method is not present on the ` Deserializer ` class itself but can be
483
483
provided by subclasses.
484
484
485
- ### class: v8.DefaultSerializer
485
+ ### Class: ` v8.DefaultSerializer `
486
486
<!-- YAML
487
487
added: v8.0.0
488
488
-->
@@ -491,7 +491,7 @@ A subclass of [`Serializer`][] that serializes `TypedArray`
491
491
(in particular [ ` Buffer ` ] [ ] ) and ` DataView ` objects as host objects, and only
492
492
stores the part of their underlying ` ArrayBuffer ` s that they are referring to.
493
493
494
- ### class: v8.DefaultDeserializer
494
+ ### Class: ` v8.DefaultDeserializer `
495
495
<!-- YAML
496
496
added: v8.0.0
497
497
-->
0 commit comments