Package Exports

safefs

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 (safefs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Safe FS

Stop getting EMFILE errors! Open only as many files as the operating system supports.

Install

npm

Install: npm install --save safefs
Require: require('safefs')

Editions

This package is published with the following editions:

safefs aliases safefs/source/index.js
safefs/source/index.js is esnext source code with require for modules

Environments older than Node.js v8 may need Babel's Polyfill or something similar.

Usage

var safefs = require('safefs')

SafeFS uses graceful-fs to wrap all of the standard file system methods to avoid EMFILE errors among other problems.

On-top of graceful-fs, SafeFS also adds additional wrapping on the following methods:

writeFile(path, data, options?, next) - ensure the full path exists before writing to it
appendFile(path, data, options?, next) - ensure the full path exists before writing to it
mkdir(path, mode?, next) - mode defaults to 0o777 & (~process.umask())
unlink(path, next) - checks if the file exists before removing it

SafeFS also define these additional methods:

ensurePath(path, options, next) - ensure the full path exists, equivalent to unix's mdir -p path
getParentPathSync(path) - returns the parent directory of the path