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 the contents of a directory.
To use in Observable,
readDir = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/fs-read-dir@umd/browser.js' )To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:
var readDir = require( 'path/to/vendor/umd/fs-read-dir/index.js' )To include the bundle in a webpage,
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/fs-read-dir@umd/browser.js"></script>If no recognized module system is present, access bundle contents via the global scope:
<script type="text/javascript">
(function () {
window.readDir;
})();
</script>Asynchronously reads the contents of a directory.
readDir( __dirname, onRead );
function onRead( error, data ) {
if ( error ) {
console.error( error );
} else {
console.log( data );
// => [...]
}
}Synchronously reads the contents of a directory.
var out = readDir.sync( __dirname );
if ( out instanceof Error ) {
throw out;
}
console.log( out );
// => [...]-
The difference between this module and
fs.readdirSync()is thatfs.readdirSync()will throw if anerroris encountered (e.g., if given a non-existentpath) and this module will return anerror. Hence, the following anti-patternvar fs = require( 'fs' ); var dir = '/path/to/dir'; // Check for existence to prevent an error being thrown... if ( fs.existsSync( dir ) ) { dir = fs.readdirSync( dir ); }
can be replaced by an approach which addresses existence via
errorhandling.var readDir = require( '@stdlib/fs-read-dir' ); var dir = '/path/to/dir'; // Explicitly handle the error... dir = readDir.sync( dir ); if ( dir instanceof Error ) { // You choose what to do... throw dir; }
<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/fs-read-dir@umd/browser.js"></script>
<script type="text/javascript">
(function () {
/* Sync */
var out = readDir.sync( __dirname );
// returns <Array>
console.log( out instanceof Error );
// => false
out = readDir.sync( 'beepboop' );
// returns <Error>
console.log( out instanceof Error );
// => true
/* Async */
readDir( __dirname, onRead );
readDir( 'beepboop', onRead );
function onRead( error, data ) {
if ( error ) {
if ( error.code === 'ENOENT' ) {
console.error( 'Directory does not exist.' );
} else {
throw error;
}
} else {
console.log( data );
}
}
})();
</script>
</body>
</html>@stdlib/fs-exists: test whether a path exists on the filesystem.@stdlib/fs-read-file: read the entire contents of a file.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.