node-file-eval
!NPM Statusnpm-imgnpm
!Travis Statustest-imgtravis
!Coverage Statuscoverage-imgcoveralls
!Dependency Statusdavid-imgdavidRead file and eval it. Uses node-eval.
Like
require
, but asynchronous and doesn't use the module cache.Important: internally
node-file-eval
will resolve passed relative paths with path.resolve()
, not require.resolve()
.Install
$ npm install --save node-file-eval
Usage
const nodeFileEval = require('node-file-eval');
fileEval('./path/to/file.js')
.then(console.log)
.catch(console.log);
API
nodeFileEval(file, options)
file
Type:string
.The filename or file descriptor.
The
node-file-eval
determinate format by extension. If filename ends with .json
extention, its contents will be parsing with JSON.parse
. If filename ends with .js
, its contents will be evaluating with vm.By default expected JS-expression or CommonJS module contents.
options
Type:Object
, string
.Options or encoding.
options.encoding
Type:string
.Default:
utf-8
.The file encoding.
options.flag
Type:string
.Default:
r
.The flag mode.
options.context
Type:Object
.The object to provide into execute method.
If
context
is specified, then module contents will be evaluating with vm.runInNewContext
.If
context
is not specified, then module contents will be evaluating with vm.runInThisContext
.With context you can provide some like-a-global variables into
node-file-eval
.const nodeFileEval = require('node-file-eval');
const secretKey = '^___^';
const contents = 'module.exports = secretKey;';
// The file has the contents "module.exports = secretKey;"
nodeFileEval('./path/to/file.js', {
context: { secretKey }
});
// ➜ '^___^'
nodeFileEval.sync(file, options)
Synchronous version of nodeFileEval.Method signature is same.
Formats
Supports CommonJS and JSON formats.See examples with evaluating files with different formats.
CommonJS
EvaluatesCommonJS
files with .js
extention.const nodeFileEval = require('node-file-eval');
// export data with `module.exports` or `exports`
nodeFileEval('./path/to/file.js');
JSON
EvaluatesJSON
files with .json
extention.const nodeFileEval = require('node-file-eval');
nodeFileEval('./path/to/file.json');
Related
- node-eval — eval Node.js contents only (JS-expression, CommonJS modules and JSON).
- any-eval — eval any contents (JS-expression, CommonJS modules and JSON/JSON5).
- file-eval — read any file and eval it with any-eval.