Skip to content

Commit

Permalink
doc: add added in versions to fs.Stats properties
Browse files Browse the repository at this point in the history
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>
jvelezpo authored and targos committed Mar 27, 2018

Verified

This commit was signed with the committer’s verified signature. The key has expired.
addaleax Anna Henningsen
1 parent efa38bd commit 157fc28
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
@@ -422,43 +422,64 @@ Stats {
```

### stats.isBlockDevice()
<!-- YAML
added: v0.1.10
-->

* Returns: {boolean}

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

### stats.isCharacterDevice()
<!-- YAML
added: v0.1.10
-->

* Returns: {boolean}

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

### stats.isDirectory()
<!-- YAML
added: v0.1.10
-->

* Returns: {boolean}

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

### stats.isFIFO()
<!-- YAML
added: v0.1.10
-->

* Returns: {boolean}

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

### stats.isFile()
<!-- YAML
added: v0.1.10
-->

* Returns: {boolean}

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

### stats.isSocket()
<!-- YAML
added: v0.1.10
-->

* Returns: {boolean}

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

### stats.isSymbolicLink()
<!-- YAML
added: v0.1.10
-->

* Returns: {boolean}

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

### stats.atimeMs
<!-- YAML
added: v8.1.0
-->

* Value: {number}

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

### stats.mtimeMs
<!-- YAML
added: v8.1.0
-->

* Value: {number}

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

### stats.ctimeMs
<!-- YAML
added: v8.1.0
-->

* Value: {number}

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

### stats.birthtimeMs
<!-- YAML
added: v8.1.0
-->

* Value: {number}

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

### stats.atime
<!-- YAML
added: v0.11.13
-->

* Value: {Date}

The timestamp indicating the last time this file was accessed.

### stats.mtime
<!-- YAML
added: v0.11.13
-->

* Value: {Date}

The timestamp indicating the last time this file was modified.

### stats.ctime
<!-- YAML
added: v0.11.13
-->

* Value: {Date}

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

### stats.birthtime
<!-- YAML
added: v0.11.13
-->

* Value: {Date}

0 comments on commit 157fc28

Please sign in to comment.