Package Exports
- @stdlib/fs-read-file
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/fs-read-file) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Read File
Read the entire contents of a file.
Installation
npm install @stdlib/fs-read-fileUsage
var readFile = require( '@stdlib/fs-read-file' );readFile( file[, options], clbk )
Asynchronously reads the entire contents of a file.
readFile( __filename, onFile );
function onFile( error, data ) {
if ( error ) {
throw error;
}
console.log( data );
}The function accepts the same options and has the same defaults as fs.readFile().
readFile.sync( file[, options] )
Synchronously reads the entire contents of a file.
var out = readFile.sync( __filename );
if ( out instanceof Error ) {
throw out;
}
console.log( out );The function accepts the same options and has the same defaults as fs.readFileSync().
Notes
The difference between this API and
fs.readFileSync()is thatfs.readFileSync()will throw if anerroris encountered (e.g., if given a non-existentpath) and this API will return anerror. Hence, the following anti-patternvar fs = require( 'fs' ); var file = '/path/to/file.js'; // Check for existence to prevent an error being thrown... if ( fs.existsSync( file ) ) { file = fs.readFileSync( file ); }
can be replaced by an approach which addresses existence via
errorhandling.var readFile = require( '@stdlib/fs-read-file' ); var file = '/path/to/file.js'; // Explicitly handle the error... file = readFile.sync( file ); if ( file instanceof Error ) { // You choose what to do... console.error( file.message ); }
Examples
var readFile = require( '@stdlib/fs-read-file' );
/* Sync */
var file = readFile.sync( __filename, 'utf8' );
// returns <string>
console.log( file instanceof Error );
// => false
file = readFile.sync( 'beepboop', {
'encoding': 'utf8'
});
// returns <Error>
console.log( file instanceof Error );
// => true
/* Async */
readFile( __filename, onFile );
readFile( 'beepboop', onFile );
function onFile( error, data ) {
if ( error ) {
if ( error.code === 'ENOENT' ) {
console.error( 'File does not exist.' );
} else {
throw error;
}
} else {
console.log( data );
}
}CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/fs-read-fileUsage
Usage: read-file [options] <filepath>
Options:
-h, --help Print this message.
-V, --version Print the package version.
--enc, --encoding encoding Encoding.
--flag flag Flag. Default: 'r'.Notes
- Relative file paths are resolved relative to the current working directory.
- Errors are written to
stderr. - File contents are written to
stdout.
Examples
$ read-file ./README.md
<file_contents>Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2021. The Stdlib Authors.