Mock FS

A configurable mock file system. You know, for testing.

Example

The code below makes it so the fs module is temporarily backed by a mock file system with a few files and directories.

var mock = require('mock-fs');

var restore = mock({
  'path/to/fake/dir': {
    'some-file.txt': 'file content here',
    'empty-dir': {/** empty directory */}
  },
  'path/to/some.png': new Buffer([8, 6, 7, 5, 3, 0, 9]),
  'some/other/path': {/** another empty directory */}
});

Note that the mock function returns a restore function. When you are ready to restore the fs module (so that it is backed by your real file system), call restore().

/// after a test runs
restore();

Status

The table below shows what is covered by the mock fs. Tests are run on Node 0.8, 0.10, and 0.11.