file-stat

file-stat

Set the stat property on a file object in a stream. Abstraction from vinyl-fs to support stream or non-stream usage.

This is inspired by the file.stat code in vinyl-fs. I needed a function that essentially did the same thing but could be used with stream or non-stream code.

Install

Install with npm

$ npm i file-stat --save

Usage

var through = require('through2');
var stats = require('file-stat');

function toStream(fp) {
  var stream = through.obj();
  stream.write({path: fp});
  stream.end();
  return stream;
}

toStream('README.md')
  .pipe(stats())
  .on('data', function (file) {
    // adds `stat` object to file
    console.log(file.stat);
  })
  .on('end', function () {
    console.log('Done.');
  });

async

A .getStats() method is exposed for non-stream usage.

stats.getStats({path: 'README.md'}, function (err, res) {
  // (typeof res.stat === 'object') => true
});

Related projects

• file-contents: Set the contents property on a file object in a stream.
• file-symlinks: Resolve symlinks and expose the stat property on a file object.
• stream-loader: create a read stream from a glob of files. can be used as a loader-cache… more
• vinyl: A virtual file format
• vinyl-fs: Vinyl adapter for the file system

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on July 15, 2015.