Skip to content

Commit 157fc28

Browse files
jvelezpotargos
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 <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent efa38bd commit 157fc28

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
@@ -422,43 +422,64 @@ Stats {
422422
```
423423

424424
### stats.isBlockDevice()
425+
<!-- YAML
426+
added: v0.1.10
427+
-->
425428

426429
* Returns: {boolean}
427430

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

430433
### stats.isCharacterDevice()
434+
<!-- YAML
435+
added: v0.1.10
436+
-->
431437

432438
* Returns: {boolean}
433439

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

436442
### stats.isDirectory()
443+
<!-- YAML
444+
added: v0.1.10
445+
-->
437446

438447
* Returns: {boolean}
439448

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

442451
### stats.isFIFO()
452+
<!-- YAML
453+
added: v0.1.10
454+
-->
443455

444456
* Returns: {boolean}
445457

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

449461
### stats.isFile()
462+
<!-- YAML
463+
added: v0.1.10
464+
-->
450465

451466
* Returns: {boolean}
452467

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

455470
### stats.isSocket()
471+
<!-- YAML
472+
added: v0.1.10
473+
-->
456474

457475
* Returns: {boolean}
458476

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

461479
### stats.isSymbolicLink()
480+
<!-- YAML
481+
added: v0.1.10
482+
-->
462483

463484
* Returns: {boolean}
464485

@@ -521,52 +542,76 @@ The file system block size for i/o operations.
521542
The number of blocks allocated for this file.
522543

523544
### stats.atimeMs
545+
<!-- YAML
546+
added: v8.1.0
547+
-->
524548

525549
* Value: {number}
526550

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

530554
### stats.mtimeMs
555+
<!-- YAML
556+
added: v8.1.0
557+
-->
531558

532559
* Value: {number}
533560

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

537564
### stats.ctimeMs
565+
<!-- YAML
566+
added: v8.1.0
567+
-->
538568

539569
* Value: {number}
540570

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

544574
### stats.birthtimeMs
575+
<!-- YAML
576+
added: v8.1.0
577+
-->
545578

546579
* Value: {number}
547580

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

551584
### stats.atime
585+
<!-- YAML
586+
added: v0.11.13
587+
-->
552588

553589
* Value: {Date}
554590

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

557593
### stats.mtime
594+
<!-- YAML
595+
added: v0.11.13
596+
-->
558597

559598
* Value: {Date}
560599

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

563602
### stats.ctime
603+
<!-- YAML
604+
added: v0.11.13
605+
-->
564606

565607
* Value: {Date}
566608

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

569611
### stats.birthtime
612+
<!-- YAML
613+
added: v0.11.13
614+
-->
570615

571616
* Value: {Date}
572617

0 commit comments

Comments
 (0)