Skip to content

Commit 6882c3a

Browse files
vsemozhetbyttargos
authored andcommitted
doc: unify property sections
PR-URL: #19869 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent f72d324 commit 6882c3a

File tree

3 files changed

+48
-48
lines changed

3 files changed

+48
-48
lines changed

doc/api/fs.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ Emitted when the `fs.ReadStream`'s file descriptor has been opened.
369369
added: v6.4.0
370370
-->
371371

372-
* Value: {number}
372+
* {number}
373373

374374
The number of bytes that have been read so far.
375375

@@ -378,7 +378,7 @@ The number of bytes that have been read so far.
378378
added: v0.1.93
379379
-->
380380

381-
* Value: {string|Buffer}
381+
* {string|Buffer}
382382

383383
The path to the file the stream is reading from as specified in the first
384384
argument to `fs.createReadStream()`. If `path` is passed as a string, then
@@ -489,61 +489,61 @@ This method is only valid when using [`fs.lstat()`][]
489489

490490
### stats.dev
491491

492-
* Value: {number}
492+
* {number}
493493

494494
The numeric identifier of the device containing the file.
495495

496496
### stats.ino
497497

498-
* Value: {number}
498+
* {number}
499499

500500
The file system specific "Inode" number for the file.
501501

502502
### stats.mode
503503

504-
* Value: {number}
504+
* {number}
505505

506506
A bit-field describing the file type and mode.
507507

508508
### stats.nlink
509509

510-
* Value: {number}
510+
* {number}
511511

512512
The number of hard-links that exist for the file.
513513

514514
### stats.uid
515515

516-
* Value: {number}
516+
* {number}
517517

518518
The numeric user identifier of the user that owns the file (POSIX).
519519

520520
### stats.gid
521521

522-
* Value: {number}
522+
* {number}
523523

524524
The numeric group identifier of the group that owns the file (POSIX).
525525

526526
### stats.rdev
527527

528-
* Value: {number}
528+
* {number}
529529

530530
A numeric device identifier if the file is considered "special".
531531

532532
### stats.size
533533

534-
* Value: {number}
534+
* {number}
535535

536536
The size of the file in bytes.
537537

538538
### stats.blksize
539539

540-
* Value: {number}
540+
* {number}
541541

542542
The file system block size for i/o operations.
543543

544544
### stats.blocks
545545

546-
* Value: {number}
546+
* {number}
547547

548548
The number of blocks allocated for this file.
549549

@@ -552,7 +552,7 @@ The number of blocks allocated for this file.
552552
added: v8.1.0
553553
-->
554554

555-
* Value: {number}
555+
* {number}
556556

557557
The timestamp indicating the last time this file was accessed expressed in
558558
milliseconds since the POSIX Epoch.
@@ -562,7 +562,7 @@ milliseconds since the POSIX Epoch.
562562
added: v8.1.0
563563
-->
564564

565-
* Value: {number}
565+
* {number}
566566

567567
The timestamp indicating the last time this file was modified expressed in
568568
milliseconds since the POSIX Epoch.
@@ -572,7 +572,7 @@ milliseconds since the POSIX Epoch.
572572
added: v8.1.0
573573
-->
574574

575-
* Value: {number}
575+
* {number}
576576

577577
The timestamp indicating the last time the file status was changed expressed
578578
in milliseconds since the POSIX Epoch.
@@ -582,7 +582,7 @@ in milliseconds since the POSIX Epoch.
582582
added: v8.1.0
583583
-->
584584

585-
* Value: {number}
585+
* {number}
586586

587587
The timestamp indicating the creation time of this file expressed in
588588
milliseconds since the POSIX Epoch.
@@ -592,7 +592,7 @@ milliseconds since the POSIX Epoch.
592592
added: v0.11.13
593593
-->
594594

595-
* Value: {Date}
595+
* {Date}
596596

597597
The timestamp indicating the last time this file was accessed.
598598

@@ -601,7 +601,7 @@ The timestamp indicating the last time this file was accessed.
601601
added: v0.11.13
602602
-->
603603

604-
* Value: {Date}
604+
* {Date}
605605

606606
The timestamp indicating the last time this file was modified.
607607

@@ -610,7 +610,7 @@ The timestamp indicating the last time this file was modified.
610610
added: v0.11.13
611611
-->
612612

613-
* Value: {Date}
613+
* {Date}
614614

615615
The timestamp indicating the last time the file status was changed.
616616

@@ -619,7 +619,7 @@ The timestamp indicating the last time the file status was changed.
619619
added: v0.11.13
620620
-->
621621

622-
* Value: {Date}
622+
* {Date}
623623

624624
The timestamp indicating the creation time of this file.
625625

doc/api/http2.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ session.on('timeout', () => { /** .. **/ });
288288
added: v9.4.0
289289
-->
290290

291-
* Value: {string|undefined}
291+
* {string|undefined}
292292

293293
Value will be `undefined` if the `Http2Session` is not yet connected to a
294294
socket, `h2c` if the `Http2Session` is not connected to a `TLSSocket`, or
@@ -315,7 +315,7 @@ If specified, the `callback` function is registered as a handler for the
315315
added: v9.4.0
316316
-->
317317

318-
* Value: {boolean}
318+
* {boolean}
319319

320320
Will be `true` if this `Http2Session` instance has been closed, otherwise
321321
`false`.
@@ -346,7 +346,7 @@ If there are any remaining open `Http2Streams` associated with the
346346
added: v8.4.0
347347
-->
348348

349-
* Value: {boolean}
349+
* {boolean}
350350

351351
Will be `true` if this `Http2Session` instance has been destroyed and must no
352352
longer be used, otherwise `false`.
@@ -356,7 +356,7 @@ longer be used, otherwise `false`.
356356
added: v9.4.0
357357
-->
358358

359-
* Value: {boolean|undefined}
359+
* {boolean|undefined}
360360

361361
Value is `undefined` if the `Http2Session` session socket has not yet been
362362
connected, `true` if the `Http2Session` is connected with a `TLSSocket`,
@@ -381,7 +381,7 @@ Transmits a `GOAWAY` frame to the connected peer *without* shutting down the
381381
added: v8.4.0
382382
-->
383383

384-
* Value: {HTTP/2 Settings Object}
384+
* {HTTP/2 Settings Object}
385385

386386
A prototype-less object describing the current local settings of this
387387
`Http2Session`. The local settings are local to *this* `Http2Session` instance.
@@ -391,7 +391,7 @@ A prototype-less object describing the current local settings of this
391391
added: v9.4.0
392392
-->
393393

394-
* Value: {string[]|undefined}
394+
* {string[]|undefined}
395395

396396
If the `Http2Session` is connected to a `TLSSocket`, the `originSet` property
397397
will return an Array of origins for which the `Http2Session` may be
@@ -402,7 +402,7 @@ considered authoritative.
402402
added: v8.4.0
403403
-->
404404

405-
* Value: {boolean}
405+
* {boolean}
406406

407407
Indicates whether or not the `Http2Session` is currently waiting for an
408408
acknowledgment for a sent SETTINGS frame. Will be `true` after calling the
@@ -460,7 +460,7 @@ instance's underlying [`net.Socket`].
460460
added: v8.4.0
461461
-->
462462

463-
* Value: {HTTP/2 Settings Object}
463+
* {HTTP/2 Settings Object}
464464

465465
A prototype-less object describing the current remote settings of this
466466
`Http2Session`. The remote settings are set by the *connected* HTTP/2 peer.
@@ -482,7 +482,7 @@ registered as a listener on the `'timeout'` event.
482482
added: v8.4.0
483483
-->
484484

485-
* Value: {net.Socket|tls.TLSSocket}
485+
* {net.Socket|tls.TLSSocket}
486486

487487
Returns a Proxy object that acts as a `net.Socket` (or `tls.TLSSocket`) but
488488
limits available methods to ones safe to use with HTTP/2.
@@ -503,7 +503,7 @@ added: v8.4.0
503503
Provides miscellaneous information about the current state of the
504504
`Http2Session`.
505505

506-
* Value: {Object}
506+
* {Object}
507507
* `effectiveLocalWindowSize` {number} The current local (receive)
508508
flow control window size for the `Http2Session`.
509509
* `effectiveRecvDataLength` {number} The current number of bytes
@@ -548,7 +548,7 @@ multiple SETTINGS frames while acknowledgment is still pending.
548548
added: v8.4.0
549549
-->
550550

551-
* Value: {number}
551+
* {number}
552552

553553
The `http2session.type` will be equal to
554554
`http2.constants.NGHTTP2_SESSION_SERVER` if this `Http2Session` instance is a
@@ -868,7 +868,7 @@ stream.on('trailers', (headers, flags) => {
868868
added: v8.4.0
869869
-->
870870

871-
* Value: {boolean}
871+
* {boolean}
872872

873873
Set to `true` if the `Http2Stream` instance was aborted abnormally. When set,
874874
the `'aborted'` event will have been emitted.
@@ -878,8 +878,8 @@ the `'aborted'` event will have been emitted.
878878
added: v8.4.0
879879
-->
880880

881-
* code {number} Unsigned 32-bit integer identifying the error code. **Default:**
882-
`http2.constants.NGHTTP2_NO_ERROR` (`0x00`).
881+
* `code` {number} Unsigned 32-bit integer identifying the error code.
882+
**Default:** `http2.constants.NGHTTP2_NO_ERROR` (`0x00`).
883883
* `callback` {Function} An optional function registered to listen for the
884884
`'close'` event.
885885

@@ -891,7 +891,7 @@ connected HTTP/2 peer.
891891
added: v9.4.0
892892
-->
893893

894-
* Value: {boolean}
894+
* {boolean}
895895

896896
Set to `true` if the `Http2Stream` instance has been closed.
897897

@@ -900,7 +900,7 @@ Set to `true` if the `Http2Stream` instance has been closed.
900900
added: v8.4.0
901901
-->
902902

903-
* Value: {boolean}
903+
* {boolean}
904904

905905
Set to `true` if the `Http2Stream` instance has been destroyed and is no longer
906906
usable.
@@ -910,7 +910,7 @@ usable.
910910
added: v9.4.0
911911
-->
912912

913-
* Value: {boolean}
913+
* {boolean}
914914

915915
Set to `true` if the `Http2Stream` instance has not yet been assigned a
916916
numeric stream identifier.
@@ -940,7 +940,7 @@ Updates the priority for this `Http2Stream` instance.
940940
added: v8.4.0
941941
-->
942942

943-
* Value: {number}
943+
* {number}
944944

945945
Set to the `RST_STREAM` [error code][] reported when the `Http2Stream` is
946946
destroyed after either receiving an `RST_STREAM` frame from the connected peer,
@@ -952,7 +952,7 @@ calling `http2stream.close()`, or `http2stream.destroy()`. Will be
952952
added: v9.5.0
953953
-->
954954

955-
* Value: {HTTP/2 Headers Object}
955+
* {HTTP/2 Headers Object}
956956

957957
An object containing the outbound headers sent for this `Http2Stream`.
958958

@@ -961,7 +961,7 @@ An object containing the outbound headers sent for this `Http2Stream`.
961961
added: v9.5.0
962962
-->
963963

964-
* Value: {HTTP/2 Headers Object[]}
964+
* {HTTP/2 Headers Object[]}
965965

966966
An array of objects containing the outbound informational (additional) headers
967967
sent for this `Http2Stream`.
@@ -971,7 +971,7 @@ sent for this `Http2Stream`.
971971
added: v9.5.0
972972
-->
973973

974-
* Value: {HTTP/2 Headers Object}
974+
* {HTTP/2 Headers Object}
975975

976976
An object containing the outbound trailers sent for this this `HttpStream`.
977977

@@ -980,7 +980,7 @@ An object containing the outbound trailers sent for this this `HttpStream`.
980980
added: v8.4.0
981981
-->
982982

983-
* Value: {Http2Session}
983+
* {Http2Session}
984984

985985
A reference to the `Http2Session` instance that owns this `Http2Stream`. The
986986
value will be `undefined` after the `Http2Stream` instance is destroyed.
@@ -1010,7 +1010,7 @@ added: v8.4.0
10101010
Provides miscellaneous information about the current state of the
10111011
`Http2Stream`.
10121012

1013-
* Value: {Object}
1013+
* {Object}
10141014
* `localWindowSize` {number} The number of bytes the connected peer may send
10151015
for this `Http2Stream` without receiving a `WINDOW_UPDATE`.
10161016
* `state` {number} A flag indicating the low-level current state of the
@@ -1122,7 +1122,7 @@ Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer.
11221122
added: v8.4.0
11231123
-->
11241124

1125-
* Value: {boolean}
1125+
* {boolean}
11261126

11271127
Boolean (read-only). True if headers were sent, false otherwise.
11281128

@@ -1131,7 +1131,7 @@ Boolean (read-only). True if headers were sent, false otherwise.
11311131
added: v8.4.0
11321132
-->
11331133

1134-
* Value: {boolean}
1134+
* {boolean}
11351135

11361136
Read-only property mapped to the `SETTINGS_ENABLE_PUSH` flag of the remote
11371137
client's most recent `SETTINGS` frame. Will be `true` if the remote peer

doc/api/inspector.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ a front-end connected to the Inspector WebSocket port.
104104
added: v8.0.0
105105
-->
106106

107-
* method {string}
108-
* params {Object}
109-
* callback {Function}
107+
* `method` {string}
108+
* `params` {Object}
109+
* `callback` {Function}
110110

111111
Posts a message to the inspector back-end. `callback` will be notified when
112112
a response is received. `callback` is a function that accepts two optional

0 commit comments

Comments
 (0)