Skip to content

doc:add documentation for the object fields return with fs.fstat #48620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
talvaknin744 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc:add documentation for the object fields return with fs.fstat #48620

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2854,6 +2854,28 @@ changes:
* `stats` {fs.Stats}

Invokes the callback with the {fs.Stats} for the file descriptor.
return an object with the following values:
```js
{
dev: 2114, # ID of the device containing file
ino: 48064969, # inode number
mode: 33188, # (type and permissions
nlink: 1, # number of hard links
uid: 85, # user ID of owner
gid: 100, # group ID of owner
rdev: 0, # device ID (if special file
size: 527, # total size in bytes
blksize: 4096, # blocksize for filesystem I/O
blocks: 8, # number of 512B blocks allocated
atimeMs: 1318289051000.1, # last access in ms
mtimeMs: 1318289051000.1, # last modification in ms
ctimeMs: 1318289051000.1, # last creation time in ms
birthtimeMs: 1318289051000.1, # creation time in ms
atime: new Date('Mon, 10 Oct 2011 23:24:11 GMT'), # last access time
mtime: new Date('Mon, 10 Oct 2011 23:24:11 GMT'), # last modify time
ctime: new Date('Mon, 10 Oct 2011 23:24:11 GMT'), # last creation time
birthtime: new Date('Mon, 10 Oct 2011 23:24:11 GMT') # last creation time
}```

See the POSIX fstat(2) documentation for more detail.

Expand Down