assert-fs-readfile-option v1.0.1

assert-fs-readfile-option

Test if a value is valid for fs.readFile options

const assertFsReadFileOption = require('assert-fs-readfile-option');

assertFsReadFileOption({encoding: 'utf8', flag: 'r'});
// doesn't throw

assertFsReadFileOption({flag: 'foo'});
// throws `TypeError [ERR_INVALID_OPT_VALUE]: The value "foo" is invalid for option "flags"`

assertFsReadFileOption('base64');
// doesn't throw

assertFsReadFileOption('base65');
// throws `TypeError [ERR_INVALID_OPT_VALUE_ENCODING]: The value "base65" is invalid for option "encoding"`

assertFsReadFileOption();
// doesn't throw

Installation

Use npm.

npm install assert-fs-readfile-option

API

const assertFsReadFileOption = require('assert-fs-readfile-option');

assertFsReadFileOption(maybeOption)

maybeOption: any types

It throws an error when the argument is not a valid value for fs.readFile options. See the test for more detailed specifications.

License

ISC License © 2017 Shinnosuke Watanabe