Have ideas to improve npm?Join in the discussion! »

fs-readfile-promise
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/fs-readfile-promise package

3.0.1 • Public • Published

fs-readfile-promise

npm version Build Status Build status Coverage Status

Promisified version of fs.readFile

const readFilePromise = require('fs-readfile-promise');
 
(async () => {
  const buffer = await readFile('path/to/a/file');
  buffer.toString(); //=> '... file contents ...'
})();

Based on the principle of modular programming, this module has only one functionality readFile, unlike other Promise-based file system modules. If you'd like to use a bunch of other fs methods in the Promise way, choose other modules such as q-io and promise-fs.

Installation

Use npm.

npm install fs-readfile-promise

API

const readFilePromise = require('fs-readfile-promise');

readFile(path [, options])

path: string Buffer URL integer
options: Object (fs.readFile options) or string (encoding)
Return: Promise<Buffer|string>

(async () => {
  await readFilePromise('src.txt'); //=> <Buffer 48 69 2e>
  await readFilePromise('src.txt', 'utf8'); //=> 'Hi.'
  await readFilePromise('src.txt', {encoding: 'base64'}); //=> 'SGku'
})();
 

License

ISC License © 2017 Shinnosuke Watanabe

Install

npm i fs-readfile-promise

DownloadsWeekly Downloads

64,249

Version

3.0.1

License

ISC

Last publish

Collaborators

  • avatar