Package Exports

@stdlib/fs
@stdlib/fs/close
@stdlib/fs/exists
@stdlib/fs/open
@stdlib/fs/read-dir
@stdlib/fs/read-file
@stdlib/fs/read-file-list
@stdlib/fs/read-json
@stdlib/fs/read-wasm
@stdlib/fs/rename
@stdlib/fs/resolve-parent-path
@stdlib/fs/unlink
@stdlib/fs/write-file

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/fs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Filesystem

Standard library for interfacing with a filesystem.

Installation

npm install @stdlib/fs

Usage

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

fs

Standard library for interfacing with a filesystem.

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

Community

License

See LICENSE.

@stdlib/fs