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
- Use:
require('safefs')
- Install:
npm install --save safefs
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 itappendFile(path, data, options?, next)
- ensure the full path exists before writing to itmkdir(path, mode?, next)
- mode defaults to0o777 & (~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'smdir -p path
getParentPathSync(path)
- returns the parent directory of the path
History
Discover the change history by heading on over to the HISTORY.md
file.
Contribute
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Backers
Maintainers
These amazing people are maintaining this project:
- Benjamin Lupton b@lupton.cc (https://github.com/balupton)
Sponsors
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
- Benjamin Lupton b@lupton.cc — view contributions
- jagill — view contributions
- sfrdmn — view contributions
- shama — view contributions
License
Unless stated otherwise all works are:
- Copyright © 2013+ Bevry Pty Ltd us@bevry.me (http://bevry.me)
- Copyright © 2011-2012 Benjamin Lupton b@lupton.cc (http://balupton.com)
and licensed under:
- The incredibly permissive MIT License