Read the entire contents of each file in a file list.
npm install @stdlib/fs-read-file-listWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Read the entire contents of each file in a file list.
``bash`
npm install @stdlib/fs-read-file-list
`javascript`
var readFileList = require( '@stdlib/fs-read-file-list' );
#### readFileList( filepaths\[, options], clbk )
Asynchronously reads the entire contents of each file in a file list.
`javascript
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][node-buffer] or string.
The function accepts the same options as [readFile()][@stdlib/fs/read-file].
#### readFileList.sync( filepaths\[, options] )
Synchronously reads the entire contents of each file in a file list.
`javascript`
var out = readFileList.sync( [ __filename ] );
if ( out instanceof Error ) {
throw out;
}
console.dir( out );
// => [{...}]
The function accepts the same options as [readFile.sync()][@stdlib/fs/read-file].
`javascript
var readFileList = require( '@stdlib/fs-read-file-list' );
/ Sync /
var files = readFileList.sync( [ __filename ], 'utf8' );
// returns
console.log( files instanceof Error );
// => false
files = readFileList.sync( [ 'beepboop' ], {
'encoding': 'utf8'
});
// returns
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 );
}
}
`
- [@stdlib/fs-read-file-list-cli][@stdlib/fs-read-file-list-cli]: CLI package for use as a command-line utility.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[@stdlib/fs-read-file-list-cli]: https://www.npmjs.com/package/@stdlib/fs-read-file-list-cli
[npm-image]: http://img.shields.io/npm/v/@stdlib/fs-read-file-list.svg
[npm-url]: https://npmjs.org/package/@stdlib/fs-read-file-list
[test-image]: https://github.com/stdlib-js/fs-read-file-list/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/fs-read-file-list/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-read-file-list/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/fs-read-file-list?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/fs-read-file-list#cli
[cli-url]: https://github.com/stdlib-js/fs-read-file-list/tree/cli
[@stdlib/fs-read-file-list]: https://github.com/stdlib-js/fs-read-file-list/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/fs-read-file-list/tree/deno
[deno-readme]: https://github.com/stdlib-js/fs-read-file-list/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/fs-read-file-list/tree/umd
[umd-readme]: https://github.com/stdlib-js/fs-read-file-list/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/fs-read-file-list/tree/esm
[esm-readme]: https://github.com/stdlib-js/fs-read-file-list/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/fs-read-file-list/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/fs-read-file-list/main/LICENSE
[@stdlib/fs/read-file]: https://www.npmjs.com/package/@stdlib/fs-read-file
[node-buffer]: https://nodejs.org/api/buffer.html
[ndjson]: http://ndjson.org/