Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

safefs

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

safefs

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

8.8.0
Source
npm

Version published: 11 months ago

Weekly downloads: 25K; decreased by-79.16%

Maintainers: 1

Weekly downloads

Created: 12 years ago

Source

Safe FS

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

Usage

Complete API Documentation.

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

Alternatives

You should use these instead, which use and provide modern APIs while providing brilliant ecosystem support:

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 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomplish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

Benjamin Lupton — view contributions
James Gill — view contributions
Kyle Robinson Young — view contributions
Sean Fridman — view contributions

Finances

Donors

License

Unless stated otherwise all works are:

and licensed under:

Artistic License 2.0

Keywords

FAQs

What is safefs?

Is safefs popular?

Is safefs well maintained?

Package last updated on 28 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

safefs