Skip to content

Commit 1d8909b

Browse files
jvelezpotrivikr
authored andcommitted
doc: add added in versions to fs.Stats properties
Adds the added in label on the documentation for each one of the properties of Class: fs.Stats PR-URL: #19266 Fixes: #19178 Reviewed-By: Adrian Estrada <edsadr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent d101942 commit 1d8909b

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

doc/api/fs.md

+45
Original file line numberDiff line numberDiff line change
@@ -421,43 +421,64 @@ Stats {
421421
```
422422

423423
### stats.isBlockDevice()
424+
<!-- YAML
425+
added: v0.1.10
426+
-->
424427

425428
* Returns: {boolean}
426429

427430
Returns `true` if the `fs.Stats` object describes a block device.
428431

429432
### stats.isCharacterDevice()
433+
<!-- YAML
434+
added: v0.1.10
435+
-->
430436

431437
* Returns: {boolean}
432438

433439
Returns `true` if the `fs.Stats` object describes a character device.
434440

435441
### stats.isDirectory()
442+
<!-- YAML
443+
added: v0.1.10
444+
-->
436445

437446
* Returns: {boolean}
438447

439448
Returns `true` if the `fs.Stats` object describes a file system directory.
440449

441450
### stats.isFIFO()
451+
<!-- YAML
452+
added: v0.1.10
453+
-->
442454

443455
* Returns: {boolean}
444456

445457
Returns `true` if the `fs.Stats` object describes a first-in-first-out (FIFO)
446458
pipe.
447459

448460
### stats.isFile()
461+
<!-- YAML
462+
added: v0.1.10
463+
-->
449464

450465
* Returns: {boolean}
451466

452467
Returns `true` if the `fs.Stats` object describes a regular file.
453468

454469
### stats.isSocket()
470+
<!-- YAML
471+
added: v0.1.10
472+
-->
455473

456474
* Returns: {boolean}
457475

458476
Returns `true` if the `fs.Stats` object describes a socket.
459477

460478
### stats.isSymbolicLink()
479+
<!-- YAML
480+
added: v0.1.10
481+
-->
461482

462483
* Returns: {boolean}
463484

@@ -520,52 +541,76 @@ The file system block size for i/o operations.
520541
The number of blocks allocated for this file.
521542

522543
### stats.atimeMs
544+
<!-- YAML
545+
added: v8.1.0
546+
-->
523547

524548
* Value: {number}
525549

526550
The timestamp indicating the last time this file was accessed expressed in
527551
milliseconds since the POSIX Epoch.
528552

529553
### stats.mtimeMs
554+
<!-- YAML
555+
added: v8.1.0
556+
-->
530557

531558
* Value: {number}
532559

533560
The timestamp indicating the last time this file was modified expressed in
534561
milliseconds since the POSIX Epoch.
535562

536563
### stats.ctimeMs
564+
<!-- YAML
565+
added: v8.1.0
566+
-->
537567

538568
* Value: {number}
539569

540570
The timestamp indicating the last time the file status was changed expressed
541571
in milliseconds since the POSIX Epoch.
542572

543573
### stats.birthtimeMs
574+
<!-- YAML
575+
added: v8.1.0
576+
-->
544577

545578
* Value: {number}
546579

547580
The timestamp indicating the creation time of this file expressed in
548581
milliseconds since the POSIX Epoch.
549582

550583
### stats.atime
584+
<!-- YAML
585+
added: v0.11.13
586+
-->
551587

552588
* Value: {Date}
553589

554590
The timestamp indicating the last time this file was accessed.
555591

556592
### stats.mtime
593+
<!-- YAML
594+
added: v0.11.13
595+
-->
557596

558597
* Value: {Date}
559598

560599
The timestamp indicating the last time this file was modified.
561600

562601
### stats.ctime
602+
<!-- YAML
603+
added: v0.11.13
604+
-->
563605

564606
* Value: {Date}
565607

566608
The timestamp indicating the last time the file status was changed.
567609

568610
### stats.birthtime
611+
<!-- YAML
612+
added: v0.11.13
613+
-->
569614

570615
* Value: {Date}
571616

0 commit comments

Comments
 (0)