read-file

2018-12-08 admin

read-file是什么

什么是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.

read-file使用教程帮助文档

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.

Related projects

  • 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.

你可能感兴趣的文章:

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-47579.html

文章标题:read-file

回到顶部