About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Read File List
Read the entire contents of each file in a file list.
Installation
npm install @stdlib/fs-read-file-list
Usage
var readFileList = require( '@stdlib/fs-read-file-list' );
readFileList( filepaths[, options], clbk )
Asynchronously reads the entire contents of each file in a file list.
readFileList( [ __filename ], onFiles );
function onFiles( error, files ) {
if ( error ) {
throw error;
}
console.dir( files );
// => [{...}]
}
Each file is represented by an object
with the following fields:
- file: file path.
-
data: file contents as either a
Buffer
orstring
.
The function accepts the same options as readFile()
.
readFileList.sync( filepaths[, options] )
Synchronously reads the entire contents of each file in a file list.
var out = readFileList.sync( [ __filename ] );
if ( out instanceof Error ) {
throw out;
}
console.dir( out );
// => [{...}]
The function accepts the same options as readFile.sync()
.
Examples
var readFileList = require( '@stdlib/fs-read-file-list' );
/* Sync */
var files = readFileList.sync( [ __filename ], 'utf8' );
// returns <ObjectArray>
console.log( files instanceof Error );
// => false
files = readFileList.sync( [ 'beepboop' ], {
'encoding': 'utf8'
});
// returns <Error>
console.log( files instanceof Error );
// => true
/* Async */
readFileList( [ __filename ], onFiles );
readFileList( [ 'beepboop' ], onFiles );
function onFiles( error, files ) {
if ( error ) {
if ( error.code === 'ENOENT' ) {
console.error( 'A file does not exist.' );
} else {
throw error;
}
} else {
console.dir( files );
}
}
See Also
-
@stdlib/fs-read-file-list-cli
: CLI package for use as a command-line utility.
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-2024. The Stdlib Authors.