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 or string.

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.