file-contents

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

Install

Install with npm:

$ npm install --save file-contents

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

Usage

var through = require('through2');
var contents = require('file-contents');

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

toStream('README.md')
  .pipe(contents())
  .on('data', function(file) {
    console.log(file.contents.toString());
  });

async

An .async() method is exposed for non-stream, async usage.

contents.async({path: 'README.md'}, function (err, file) {
  // results in something like:
  // 
  //   { path: 'README.md',
  //   stat:
  //    { dev: 16777218,
  //      mode: 33188,
  //      nlink: 1,
  //      uid: 501,
  //      gid: 20,
  //      rdev: 0,
  //      blksize: 4096,
  //      ino: 26436116,
  //      size: 2443,
  //      blocks: 8,
  //      atime: Fri Jul 17 2015 03:01:54 GMT-0400 (EDT),
  //      mtime: Wed Jul 15 2015 02:46:55 GMT-0400 (EDT),
  //      ctime: Wed Jul 15 2015 02:46:55 GMT-0400 (EDT),
  //      birthtime: Tue Jul 14 2015 23:03:58 GMT-0400 (EDT) },
  // contents: <Buffer 23 20 66 69 6c 65 2d 63 6f 6e 74 65 6e 74 73 20 5b 21 5b 4e 50 4d 20 76 65 72 73 69 6f 6e 5d 28 68 74 74 70 73 3a 2f 2f 62 61 64 67 65 2e 66 75 72 79 ... > }
});

sync

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

var file = {path: 'README.md'};
contents.sync(file);
// results in something like:
// 
//   { path: 'README.md',
//   stat:
//    { dev: 16777218,
//      mode: 33188,
//      nlink: 1,
//      uid: 501,
//      gid: 20,
//      rdev: 0,
//      blksize: 4096,
//      ino: 26436116,
//      size: 2443,
//      blocks: 8,
//      atime: Fri Jul 17 2015 03:01:54 GMT-0400 (EDT),
//      mtime: Wed Jul 15 2015 02:46:55 GMT-0400 (EDT),
//      ctime: Wed Jul 15 2015 02:46:55 GMT-0400 (EDT),
//      birthtime: Tue Jul 14 2015 23:03:58 GMT-0400 (EDT) },
// contents: <Buffer 23 20 66 69 6c 65 2d 63 6f 6e 74 65 6e 74 73 20 5b 21 5b 4e 50 4d 20 76 65 72 73 69 6f 6e 5d 28 68 74 74 70 73 3a 2f 2f 62 61 64 67 65 2e 66 75 72 79 ... > }

History

v0.2.0

renames .getContents method to .async
adds .sync method

About

Related projects

file-stat: Set the stat property on a file object. Abstraction from vinyl-fs to support stream or… more | homepage
file-symlinks: Resolve symlinks and expose the stat property on a file object. | homepage
stream-loader: create a read stream from a glob of files. can be used as a loader-cache… more | homepage
vinyl-fs: Vinyl adapter for the file system | homepage
vinyl: Virtual file format. | homepage

Contributing

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

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.4.2, on February 03, 2017.

Current Tags

1.0.1 ... latest (8 years ago)