search

gulpjs / vinyl

Virtual file format.
MIT License
1.28k stars 107 forks source link

Add documentation for `file.stat` #120

Closed demurgos closed 7 years ago

demurgos commented 7 years ago

This PR follows #119

It documents the file.stat property of Vinyl instances.

This is a simple property, without any getter or setter; but it is accessible and has a meaning so this should be documented: it's a part of the API.

phated commented 7 years ago

Ref https://github.com/gulpjs/vinyl/issues/119#issuecomment-254365691

demurgos commented 7 years ago

Hi, I posted a new proposition in the related issue, does it suits you better ?

phated commented 7 years ago

I don't like documenting this as a property because it doesn't exist if you don't pass it as an option. If an empty fs.Stat object were generated in each constructor, then this documentation would be correct; however, we aren't going to implement something like that until #105 is addressed.

phated commented 7 years ago

I think I'm going to close this until #105 is addressed.