FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc,v8: use code markup/markdown in headers · nodejs/node@7d2748a · GitHub

/ node Public

Commit 7d2748a

Browse files
Trott
authored and
MylesBorins
committed
doc,v8: use code markup/markdown in headers
Backport-PR-URL: #31108 PR-URL: #31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 3295644 commit 7d2748a

1 file changed

Lines changed: 36 additions & 36 deletions

File tree

‎doc/api/v8.md‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const v8 = require('v8');
1111

1212
The APIs and implementation are subject to change at any time.
1313

14-
## v8.cachedDataVersionTag()
14+
## `v8.cachedDataVersionTag()`
1515
<!-- YAML
1616
added: v8.0.0
1717
-->
@@ -23,7 +23,7 @@ command line flags and detected CPU features. This is useful for determining
2323
whether a [`vm.Script`][] `cachedData` buffer is compatible with this instance
2424
of V8.
2525

26-
## v8.getHeapSpaceStatistics()
26+
## `v8.getHeapSpaceStatistics()`
2727
<!-- YAML
2828
added: v6.0.0
2929
changes:
@@ -88,7 +88,7 @@ The value returned is an array of objects containing the following properties:
8888
]
8989
```
9090

91-
## v8.getHeapSnapshot()
91+
## `v8.getHeapSnapshot()`
9292
<!-- YAML
9393
added: v11.13.0
9494
-->
@@ -106,7 +106,7 @@ const stream = v8.getHeapSnapshot();
106106
stream.pipe(process.stdout);
107107
```
108108

109-
## v8.getHeapStatistics()
109+
## `v8.getHeapStatistics()`
110110
<!-- YAML
111111
added: v1.0.0
112112
changes:
@@ -166,7 +166,7 @@ being non-zero indicates a potential memory leak.
166166
}
167167
```
168168

169-
## v8.getHeapCodeStatistics()
169+
## `v8.getHeapCodeStatistics()`
170170
<!-- YAML
171171
added: v12.8.0
172172
-->
@@ -188,7 +188,7 @@ Returns an object with the following properties:
188188
}
189189
```
190190

191-
## v8.setFlagsFromString(flags)
191+
## `v8.setFlagsFromString(flags)`
192192
<!-- YAML
193193
added: v1.0.0
194194
-->
@@ -212,7 +212,7 @@ v8.setFlagsFromString('--trace_gc');
212212
setTimeout(() => { v8.setFlagsFromString('--notrace_gc'); }, 60e3);
213213
```
214214

215-
## v8.writeHeapSnapshot(\[filename\])
215+
## `v8.writeHeapSnapshot([filename])`
216216
<!-- YAML
217217
added: v11.13.0
218218
-->
@@ -270,7 +270,7 @@ The serialization API provides means of serializing JavaScript values in a way
270270
that is compatible with the [HTML structured clone algorithm][].
271271
The format is backward-compatible (i.e. safe to store to disk).
272272

273-
### v8.serialize(value)
273+
### `v8.serialize(value)`
274274
<!-- YAML
275275
added: v8.0.0
276276
-->
@@ -280,7 +280,7 @@ added: v8.0.0
280280

281281
Uses a [`DefaultSerializer`][] to serialize `value` into a buffer.
282282

283-
### v8.deserialize(buffer)
283+
### `v8.deserialize(buffer)`
284284
<!-- YAML
285285
added: v8.0.0
286286
-->
@@ -290,19 +290,19 @@ added: v8.0.0
290290
Uses a [`DefaultDeserializer`][] with default options to read a JS value
291291
from a buffer.
292292

293-
### class: v8.Serializer
293+
### Class: `v8.Serializer`
294294
<!-- YAML
295295
added: v8.0.0
296296
-->
297297

298-
#### new Serializer()
298+
#### `new Serializer()`
299299
Creates a new `Serializer` object.
300300

301-
#### serializer.writeHeader()
301+
#### `serializer.writeHeader()`
302302

303303
Writes out a header, which includes the serialization format version.
304304

305-
#### serializer.writeValue(value)
305+
#### `serializer.writeValue(value)`
306306

307307
* `value` {any}
308308

@@ -311,15 +311,15 @@ internal buffer.
311311

312312
This throws an error if `value` cannot be serialized.
313313

314-
#### serializer.releaseBuffer()
314+
#### `serializer.releaseBuffer()`
315315

316316
* Returns: {Buffer}
317317

318318
Returns the stored internal buffer. This serializer should not be used once
319319
the buffer is released. Calling this method results in undefined behavior
320320
if a previous write has failed.
321321

322-
#### serializer.transferArrayBuffer(id, arrayBuffer)
322+
#### `serializer.transferArrayBuffer(id, arrayBuffer)`
323323

324324
* `id` {integer} A 32-bit unsigned integer.
325325
* `arrayBuffer` {ArrayBuffer} An `ArrayBuffer` instance.
@@ -328,37 +328,37 @@ Marks an `ArrayBuffer` as having its contents transferred out of band.
328328
Pass the corresponding `ArrayBuffer` in the deserializing context to
329329
[`deserializer.transferArrayBuffer()`][].
330330

331-
#### serializer.writeUint32(value)
331+
#### `serializer.writeUint32(value)`
332332

333333
* `value` {integer}
334334

335335
Write a raw 32-bit unsigned integer.
336336
For use inside of a custom [`serializer._writeHostObject()`][].
337337

338-
#### serializer.writeUint64(hi, lo)
338+
#### `serializer.writeUint64(hi, lo)`
339339

340340
* `hi` {integer}
341341
* `lo` {integer}
342342

343343
Write a raw 64-bit unsigned integer, split into high and low 32-bit parts.
344344
For use inside of a custom [`serializer._writeHostObject()`][].
345345

346-
#### serializer.writeDouble(value)
346+
#### `serializer.writeDouble(value)`
347347

348348
* `value` {number}
349349

350350
Write a JS `number` value.
351351
For use inside of a custom [`serializer._writeHostObject()`][].
352352

353-
#### serializer.writeRawBytes(buffer)
353+
#### `serializer.writeRawBytes(buffer)`
354354

355355
* `buffer` {Buffer|TypedArray|DataView}
356356

357357
Write raw bytes into the serializer’s internal buffer. The deserializer
358358
will require a way to compute the length of the buffer.
359359
For use inside of a custom [`serializer._writeHostObject()`][].
360360

361-
#### serializer.\_writeHostObject(object)
361+
#### `serializer._writeHostObject(object)`
362362

363363
* `object` {Object}
364364

@@ -369,7 +369,7 @@ exception should be thrown.
369369
This method is not present on the `Serializer` class itself but can be provided
370370
by subclasses.
371371

372-
#### serializer.\_getDataCloneError(message)
372+
#### `serializer._getDataCloneError(message)`
373373

374374
* `message` {string}
375375

@@ -379,7 +379,7 @@ object can not be cloned.
379379
This method defaults to the [`Error`][] constructor and can be overridden on
380380
subclasses.
381381

382-
#### serializer.\_getSharedArrayBufferId(sharedArrayBuffer)
382+
#### `serializer._getSharedArrayBufferId(sharedArrayBuffer)`
383383

384384
* `sharedArrayBuffer` {SharedArrayBuffer}
385385

@@ -394,36 +394,36 @@ If the object cannot be serialized, an exception should be thrown.
394394
This method is not present on the `Serializer` class itself but can be provided
395395
by subclasses.
396396

397-
#### serializer.\_setTreatArrayBufferViewsAsHostObjects(flag)
397+
#### `serializer._setTreatArrayBufferViewsAsHostObjects(flag)`
398398

399399
* `flag` {boolean} **Default:** `false`
400400

401401
Indicate whether to treat `TypedArray` and `DataView` objects as
402402
host objects, i.e. pass them to [`serializer._writeHostObject()`][].
403403

404-
### class: v8.Deserializer
404+
### Class: `v8.Deserializer`
405405
<!-- YAML
406406
added: v8.0.0
407407
-->
408408

409-
#### new Deserializer(buffer)
409+
#### `new Deserializer(buffer)`
410410

411411
* `buffer` {Buffer|TypedArray|DataView} A buffer returned by
412412
[`serializer.releaseBuffer()`][].
413413

414414
Creates a new `Deserializer` object.
415415

416-
#### deserializer.readHeader()
416+
#### `deserializer.readHeader()`
417417

418418
Reads and validates a header (including the format version).
419419
May, for example, reject an invalid or unsupported wire format. In that case,
420420
an `Error` is thrown.
421421

422-
#### deserializer.readValue()
422+
#### `deserializer.readValue()`
423423

424424
Deserializes a JavaScript value from the buffer and returns it.
425425

426-
#### deserializer.transferArrayBuffer(id, arrayBuffer)
426+
#### `deserializer.transferArrayBuffer(id, arrayBuffer)`
427427

428428
* `id` {integer} A 32-bit unsigned integer.
429429
* `arrayBuffer` {ArrayBuffer|SharedArrayBuffer} An `ArrayBuffer` instance.
@@ -433,37 +433,37 @@ Pass the corresponding `ArrayBuffer` in the serializing context to
433433
[`serializer.transferArrayBuffer()`][] (or return the `id` from
434434
[`serializer._getSharedArrayBufferId()`][] in the case of `SharedArrayBuffer`s).
435435

436-
#### deserializer.getWireFormatVersion()
436+
#### `deserializer.getWireFormatVersion()`
437437

438438
* Returns: {integer}
439439

440440
Reads the underlying wire format version. Likely mostly to be useful to
441441
legacy code reading old wire format versions. May not be called before
442442
`.readHeader()`.
443443

444-
#### deserializer.readUint32()
444+
#### `deserializer.readUint32()`
445445

446446
* Returns: {integer}
447447

448448
Read a raw 32-bit unsigned integer and return it.
449449
For use inside of a custom [`deserializer._readHostObject()`][].
450450

451-
#### deserializer.readUint64()
451+
#### `deserializer.readUint64()`
452452

453453
* Returns: {integer[]}
454454

455455
Read a raw 64-bit unsigned integer and return it as an array `[hi, lo]`
456456
with two 32-bit unsigned integer entries.
457457
For use inside of a custom [`deserializer._readHostObject()`][].
458458

459-
#### deserializer.readDouble()
459+
#### `deserializer.readDouble()`
460460

461461
* Returns: {number}
462462

463463
Read a JS `number` value.
464464
For use inside of a custom [`deserializer._readHostObject()`][].
465465

466-
#### deserializer.readRawBytes(length)
466+
#### `deserializer.readRawBytes(length)`
467467

468468
* `length` {integer}
469469
* Returns: {Buffer}
@@ -473,7 +473,7 @@ must correspond to the length of the buffer that was passed to
473473
[`serializer.writeRawBytes()`][].
474474
For use inside of a custom [`deserializer._readHostObject()`][].
475475

476-
#### deserializer.\_readHostObject()
476+
#### `deserializer._readHostObject()`
477477

478478
This method is called to read some kind of host object, i.e. an object that is
479479
created by native C++ bindings. If it is not possible to deserialize the data,
@@ -482,7 +482,7 @@ a suitable exception should be thrown.
482482
This method is not present on the `Deserializer` class itself but can be
483483
provided by subclasses.
484484

485-
### class: v8.DefaultSerializer
485+
### Class: `v8.DefaultSerializer`
486486
<!-- YAML
487487
added: v8.0.0
488488
-->
@@ -491,7 +491,7 @@ A subclass of [`Serializer`][] that serializes `TypedArray`
491491
(in particular [`Buffer`][]) and `DataView` objects as host objects, and only
492492
stores the part of their underlying `ArrayBuffer`s that they are referring to.
493493

494-
### class: v8.DefaultDeserializer
494+
### Class: `v8.DefaultDeserializer`
495495
<!-- YAML
496496
added: v8.0.0
497497
-->

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL