Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

readutf

tandrewnichols1.2kMIT1.0.2

A thin wrapper around fs.readFile that automatically sets the encoding to utf8 on your behest

fs, readfile, writefile, utf8, utf, read, write, file

readme

Build Status downloads npm Code Climate Test Coverage dependencies

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.