read-utf8-file

A Node.js module to read the contents of a UTF-8 file

const readUtf8File = require('read-utf8-file');
 
(async () => {
  const contents = await readUtf8File('/path/to/utf8-file.txt');
  //=> 'string of file contents'
})();

Installation

Use npm.

npm install read-utf8-file

API

const readUtf8File = require('read-utf8-file');

readUtf8File(filePath [, options])

filePath: string | Buffer | Uint8Array | URL (file path)
options: Object (fs.promises.readFile() options except for encoding)
Return: Promise<string> (entire file contents except for BOM)

// file-with-bom.txt: '\uFEFFabc'
 
(async () => {
  await readUtf8File('file-with-bom.txt'); //=> 'abc'
})();

If the file is not UTF-8 encoded, the Promise will be rejected. So this module is more suitable than built-in fs.readFile() for the case when the program doesn't support non-UTF-8 files.

(async () => {
  await readUtf8File('/path/to/non-utf8-file');
  // rejects with Error: Expected a UTF-8 file, but the file at '/path/to/non-utf8-file' is not UTF-8 encoded.
})();

License

ISC License © 2017 - 2019 Watanabe Shinnosuke