Thin wrapper around fs.readFile and fs.readFileSync that also strips byte order marks when `utf8` encoding is chosen. Also optionally replaces windows newlines with unix newlines.
npm install read-file> Thin wrapper around fs.readFile and fs.readFileSync that also strips byte order marks when utf8 encoding is chosen. Also optionally replaces windows newlines with unix newlines.
Install with npm
``sh`
$ npm i read-file --save
`js
var read = require('read-file');
// async
read('foo.txt', function(err, buffer) {
//=>
});
// sync
var buffer = read.sync('foo.txt');
//=>
`
if utf8 encoding is used, byte order marks will be stripped
async
`js
read('foo.txt', 'utf8', function(err, buffer) {
//=> 'some contents...'
});
// or
read('foo.txt', {encoding: 'utf8'} function(err, buffer) {
//=> 'some contents...'
});
`
sync
`js`
read.sync('foo.txt', 'utf8');
// or
read('foo.txt', {encoding: 'utf8'});
Pass { normalize: true } on the options to strip windows carriage returns. This will also return a utf8 string.
* copy: Copy files or directories using globs.
* read-yaml: Very thin wrapper around js-yaml for directly reading in YAML files.
* read-data: Read JSON or YAML files.
* write: Write files to disk, creating intermediate directories if they don't exist.
Install dev dependencies:
`sh``
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Jon Schlinkert
+ github/jonschlinkert
+ twitter/jonschlinkert
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
*
_This file was generated by verb-cli on July 17, 2015._