Thin wrapper around fs.readFile and fs.readFileSync that also strips byte order marks when
utf8encoding is chosen. Also optionally replaces windows newlines with unix newlines.
Install with npm
$ npm i read-file --savevar read = require('read-file');
// async
read('foo.txt', function(err, buffer) {
//=> <Buffer 74 68 69 73 20 69 73 20 66 6f 6f>
});
// sync
var buffer = read.sync('foo.txt');
//=> <Buffer 74 68 69 73 20 69 73 20 66 6f 6f>if utf8 encoding is used, byte order marks will be stripped
async
read('foo.txt', 'utf8', function(err, buffer) {
//=> 'some contents...'
});
// or
read('foo.txt', {encoding: 'utf8'}, function(err, buffer) {
//=> 'some contents...'
});sync
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:
$ npm i -d && npm testPull requests and stars are always welcome. For bugs and feature requests, please create an issue
Jon Schlinkert
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on July 17, 2015.