safefs

    6.16.0 • Public • Published

    Safe FS

    Status of the GitHub Workflow: bevry NPM version NPM downloads Dependency Status Dev Dependency Status
    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

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

    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

    Install

    npm

    • Install: npm install --save safefs
    • Import: import * as pkg from ('safefs')
    • Require: const pkg = 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 for Node.js 10 || 12 || 14 || 16 with Require for modules

    History

    Discover the release 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:

    Sponsors

    No sponsors yet! Will you be the first?

    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    License

    Unless stated otherwise all works are:

    and licensed under:

    Install

    npm i safefs

    DownloadsWeekly Downloads

    149,657

    Version

    6.16.0

    License

    MIT

    Unpacked Size

    26.9 kB

    Total Files

    5

    Last publish

    Collaborators

    • balupton
    • bevryme