Package Exports

unionfs

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 (unionfs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

unionfs

Creates a union of multiple fs file systems.

This module allows you to use multiple objects that have file system fs API at the same time.

Use this module with memfs and linkfs. memfs allows you to create virtual in-memory file system. linkfs allows you to rewrite fs paths.

var fs = require('fs');
var unionfs = require('unionfs');
var linkfs = require('linkfs');
var memfs = require('memfs');


// Create a virtual file.
var mem = new memfs.Volume;
mem.mountSync('/usr/mem', {
    'dir/hello.js': 'console.log("Hello world!");'
});
console.log(mem.readFileSync('/usr/mem/dir/hello.js').toString());
// console.log("Hello world!");


// Create a filesystem whose paths are rewritten.
var link = linkfs(mem, {'/project': '/usr/mem/dir'});
console.log(link.readFileSync('/project/hello.js').toString());
// console.log("Hello world!");


// Combine three file systems, to create a union of file systems.
unionfs
    .use(fs)
    .use(mem)
    .use(link);
console.log(unionfs.readFileSync('/usr/mem/dir/hello.js').toString());
// console.log("Hello world!");
console.log(unionfs.readFileSync('/project/hello.js').toString());
// console.log("Hello world!");


// Rewrite the real `fs` module with `unionfs`.
unionfs.replace(fs);
console.log(fs.readFileSync('/usr/mem/dir/hello.js').toString());
// console.log("Hello world!");
console.log(fs.readFileSync('/project/hello.js').toString());
// console.log("Hello world!");


// Now you can also do:
require('/usr/mem/dir/hello.js');
// Hello world!
require('/project/hello.js');
// Hello world!