Question 1

How do I use graceful-fs in my Node.js project?

Accepted Answer

Simply require it as a drop-in replacement for the native fs module, like `var fs = require('graceful-fs')`, and use it for all filesystem operations. For global patching, call `gracefulFs.gracefulify(realFs)` at the top-level application layer only.

Question 2

Does graceful-fs work with synchronous methods?

Accepted Answer

No, it cannot handle EMFILE or ENFILE errors for synchronous fs methods. The README explicitly states this is a known limitation, and developers are responsible for error handling in sync code.

Question 3

What are the performance costs of using graceful-fs?

Accepted Answer

It prioritizes stability over speed by queuing operations to avoid errors, which can slow down filesystem access. This trade-off is intentional, as mentioned in the philosophy section of the README.

Question 4

graceful-fs vs native fs: which should I choose?

Accepted Answer

Choose graceful-fs if you need automatic error handling for EMFILE, antivirus issues, or cross-platform consistency. Stick with native fs for maximum performance or if you only use synchronous methods and handle errors manually.

Question 5

How to patch the global fs module with graceful-fs?

Accepted Answer

Use `gracefulFs.gracefulify(realFs)` at the application's top level, not in libraries, to avoid side-effects. This monkey-patches the fs module globally, but the README cautions against doing this in dependencies.

Question 6

Is graceful-fs compatible with all Node.js versions?

Accepted Answer

It supports Node.js from 0.8 through 7.0 and likely beyond, but major version changes (e.g., v3 to v4) can be breaking due to shifts in patching approach, so check compatibility for your version.

graceful-fs

What is graceful-fs?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions