readutf
Version:
A thin wrapper around fs.readFile that automatically sets the encoding to utf8 on your behest
28 lines (17 loc) • 1.38 kB
Markdown
[](https://travis-ci.org/tandrewnichols/readutf) [](https://npmjs.org/package/readutf) [](https://npmjs.org/package/readutf) [](https://codeclimate.com/github/tandrewnichols/readutf) [](https://codeclimate.com/github/tandrewnichols/readutf) [](https://david-dm.org/tandrewnichols/readutf)
# readutf
A thin wrapper around fs.readFile that automatically sets the encoding to utf8 on your behest
## Installation
`npm install --save readutf`
## Summary
I typically forget that "utf8" is not the default encoding when reading in a file. This wrapper sets `{ encoding: 'utf8' }` on `fs.readFile` and `fs.readFileSync` so you can pass only a filename or filename and callback.
## Usage
```
var utf = require('readutf');
utf.readFile('./lib/filename.txt', function(err, contents) {
// "contents" is a string
});
var contents = utf.readFileSync('./lib/other-thing.ext'); // Also a string
```
## Contributing
Please see [the contribution guidelines](CONTRIBUTING.md).