JSPM

read-file

0.2.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 54059
  • Score
    100M100P100Q143624F
  • License MIT

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.

Package Exports

  • read-file

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (read-file) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

read-file NPM version

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

$ npm i read-file --save

Usage

var 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>

BOM

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'});

options.normalize

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.

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

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

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