readutf

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
readutf
011.0.27 years ago7 years agoMinified + gzip package size for readutf in KB

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.