Skip to content
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.

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

Node docs for when mtimeMs and friends were added. #19178

Closed
jdalton opened this issue Mar 6, 2018 · 2 comments
Closed

Node docs for when mtimeMs and friends were added. #19178

jdalton opened this issue Mar 6, 2018 · 2 comments

Comments

@jdalton
Copy link
Member

jdalton commented Mar 6, 2018

Currently the Node fs.Stats entry has a history summary mentioning times as numbers

but I found that easy to miss. It would be nice if the actual entry documented had the mention

@addaleax
Copy link
Member

addaleax commented Mar 6, 2018

I guess we could add added: entries for all of the individual field headings?

@jvelezpo
Copy link
Contributor

jvelezpo commented Mar 8, 2018

Let me see if i understood this and if you want i can make a PR for this

we will be adding added: to each of this (if so, I have a question here, how do i know the Added in version for each one of these?)

stats.isBlockDevice()
stats.isCharacterDevice()
stats.isDirectory()
stats.isFIFO()
stats.isFile()
stats.isSocket()
stats.isSymbolicLink()
stats.dev
stats.ino
stats.mode
stats.nlink
stats.uid
stats.gid
stats.rdev
stats.blksize
stats.blocks
stats.atimeMs
stats.mtimeMs
stats.ctimeMs
stats.birthtimeMs
stats.atime
stats.mtime
stats.ctime
stats.birthtime

Stat Time Values

so they will look like this:
image

targos pushed a commit that referenced this issue Mar 27, 2018
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants