Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeman99/stats-ctor
nodejs fs.Stats constructor with sane signature and defaults.
https://github.com/codeman99/stats-ctor
fs node stats
Last synced: about 1 month ago
JSON representation
nodejs fs.Stats constructor with sane signature and defaults.
- Host: GitHub
- URL: https://github.com/codeman99/stats-ctor
- Owner: CodeMan99
- License: isc
- Created: 2018-03-29T20:42:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-19T01:16:24.000Z (almost 6 years ago)
- Last Synced: 2024-10-02T08:20:55.485Z (about 2 months ago)
- Topics: fs, node, stats
- Language: JavaScript
- Size: 9.77 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# stats-ctor [](https://travis-ci.org/CodeMan99/stats-ctor)
[`fs.Stats`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_class_fs_stats) constructor with a sane signature and defaults.
## Usage
Sane defaults.
```javascript
var Stats = require('stats-ctor');
var stat = new Stats();
console.log(stat.mode); // 0
console.log(stat.uid); // 1000 - from `process.getuid()`
console.log(stat.mtime); // 2018-03-29T17:01:48.883Z - from `new Date()`
```
Sane single argument signature.
```javascript
var fs = require('fs');
var Stats = require('stats-ctor');
var umask = 0o002;
var stat = new Stats({
mode: fs.constats.S_IFREG | (umask ^ 0o777)
});
console.log(stat.mode); // 33277
```
Free copy constructor.
```javascript
var fs = require('fs');
var Stats = require('stats-ctor');
var stat = fs.statSync('./README.md');
var copy = new Stats(stat);
console.log(stat === copy); // false
console.log(stat.mtime.getTime() === copy.mtime.getTime()); // true - same for all properties on the copy instance
```
## API
### Stats([options])
Identical to the `fs.Stats` constructor in node core, except it has a single
options argument instead of _fourteen_ named arguments.
#### options
Type: `Object`
Simply uses the named arguments from `fs.Stats` as property names.
##### dev
Type: `Number`
Default: `0`
##### mode
Type: `Number`
Default: `0`
You should create a real mode for most use cases. See [`fs.constants`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_file_type_constants). For example when creating a new regular file do `fs.constants.S_IFREG | (process.umask() ^ 0o666)`.
##### nlink
Type: `Number`
Default: `0`
##### uid
Type: `Number`
Default: `process.getuid()`
##### gid
Type: `Number`
Default: `process.getgid()`
##### rdev
Type: `Number`
Default: `0`
##### blksize
Type: `Number`
Default: `0`
##### ino
Type: `Number`
Default: `0`
##### size
Type: `Number`
Default: `0`
##### blocks
Type: `Number`
Default: `0`
##### atim_msec
Type: `Number`
Default: `Date.now()`
This property creates a `Date` instance called `atime`.
##### mtim_msec
Type: `Number`
Default: `Date.now()`
This property creates a `Date` instance called `mtime`.
##### ctim_msec
Type: `Number`
Default: `Date.now()`
This property creates a `Date` instance called `ctime`.
##### birthtim_msec
Type: `Number`
Default: `Date.now()`
This property creates a `Date` instance called `birthtime`.
#### Stats.prototype.atim_msec
Type: `Number`
A millisecond getter/setter for `atime`.
If available on the instance, setter will update `atimeMs`.
#### Stats.prototype.mtim_msec
Type: `Number`
A millisecond getter/setter for `mtime`.
If available on the instance, setter will update `mtimeMs`.
#### Stats.prototype.ctim_msec
Type: `Number`
A millisecond getter/setter for `ctime`.
If available on the instance, setter will update `ctimeMs`.
#### Stats.prototype.birthtim_msec
Type: `Number`
A millisecond getter/setter for `birthtime`.
If available on the instance, setter will update `birthtimeMs`.
## Warning
Node added millisecond properties starting with *v8.1.0*. However, these are
instance properties and are disconnected with the `Date` equivalent. For
example, updating `stat.mtimeMs` will not update `stat.mtime`.
As such this module makes `atimeMs`, `ctimeMs`, `mtimeMs`, & `birthtimeMs`
non-enumerable. Instead use the prototype properties above.
## Related
* [clone-stats](https://github.com/hughsk/clone-stats) Copying existing `fs.Stats` instances.
* [stat-mode](https://github.com/TooTallNate/stat-mode) Sane handling of the `mode` property.
## License
ISC - Copyright © 2018, Cody A. Taylor.