Skip to content

Commit 08a36a0

Browse files
committed
doc: unify property sections
PR-URL: #19869 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 53035b1 commit 08a36a0

File tree

3 files changed

+49
-49
lines changed

3 files changed

+49
-49
lines changed

doc/api/fs.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ Emitted when the `fs.ReadStream`'s file descriptor has been opened.
368368
added: v6.4.0
369369
-->
370370

371-
* Value: {number}
371+
* {number}
372372

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

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

380-
* Value: {string|Buffer}
380+
* {string|Buffer}
381381

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

489489
### stats.dev
490490

491-
* Value: {number}
491+
* {number}
492492

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

495495
### stats.ino
496496

497-
* Value: {number}
497+
* {number}
498498

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

501501
### stats.mode
502502

503-
* Value: {number}
503+
* {number}
504504

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

507507
### stats.nlink
508508

509-
* Value: {number}
509+
* {number}
510510

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

513513
### stats.uid
514514

515-
* Value: {number}
515+
* {number}
516516

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

519519
### stats.gid
520520

521-
* Value: {number}
521+
* {number}
522522

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

525525
### stats.rdev
526526

527-
* Value: {number}
527+
* {number}
528528

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

531531
### stats.size
532532

533-
* Value: {number}
533+
* {number}
534534

535535
The size of the file in bytes.
536536

537537
### stats.blksize
538538

539-
* Value: {number}
539+
* {number}
540540

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

543543
### stats.blocks
544544

545-
* Value: {number}
545+
* {number}
546546

547547
The number of blocks allocated for this file.
548548

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

554-
* Value: {number}
554+
* {number}
555555

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

564-
* Value: {number}
564+
* {number}
565565

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

574-
* Value: {number}
574+
* {number}
575575

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

584-
* Value: {number}
584+
* {number}
585585

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

594-
* Value: {Date}
594+
* {Date}
595595

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

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

603-
* Value: {Date}
603+
* {Date}
604604

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

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

612-
* Value: {Date}
612+
* {Date}
613613

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

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

621-
* Value: {Date}
621+
* {Date}
622622

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

@@ -3472,7 +3472,7 @@ unclosed file descriptors after a `Promise` is resolved or rejected.
34723472
added: REPLACEME
34733473
-->
34743474

3475-
Value: {number} The numeric file descriptor managed by the `FileHandle` object.
3475+
* {number} The numeric file descriptor managed by the `FileHandle` object.
34763476

34773477
#### filehandle.appendFile(data, options)
34783478
<!-- YAML

doc/api/http2.md

Lines changed: 25 additions & 25 deletions
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

0 commit comments

Comments
 (0)