<summary> About stdlib... </summary>

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!

Filesystem

Filesystem APIs.

Installation

npm install @stdlib/fs

Usage

var fs = require( '@stdlib/fs' );

fs

Namespace for filesystem APIs.

var f = fs;
// returns {...}

close( fd, clbk ): close a file descriptor.
exists( path, clbk ): test whether a path exists on the filesystem.
open( path[, flags[, mode]], clbk ): open a file.
readDir( path, clbk ): read the contents of a directory.
readFileList( filepaths[, options], clbk ): read the entire contents of each file in a file list.
readFile( file[, options], clbk ): read the entire contents of a file.
readJSON( file[, options], clbk ): read a file as JSON.
readWASM( file[, options], clbk ): read a file as WebAssembly.
rename( oldPath, newPath, clbk ): rename a file.
resolveParentPathBy( path[, options], predicate, clbk ): resolve a path according to a predicate function by walking parent directories.
resolveParentPath( path[, options], clbk ): resolve a path by walking parent directories.
unlink( path, clbk ): remove a directory entry.
writeFile( file, data[, options], clbk ): write data to a file.

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var fs = require( '@stdlib/fs' );

console.log( objectKeys( fs ) );

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.

Filesystem

Installation

Usage

fs

Examples

Notice

Community

License

Copyright

Current Tags

21 Versions