unionfs

Use multiple `fs` modules in a union.

30 个版本

fs file file system mount union unionfs many file systems multiple

主页

仓库

提交 Issue

安装

npm install unionfs

yarn add unionfs

pnpm add unionfs

bun add unionfs

README

unionfs

Creates a union of multiple fs file systems.

npm install --save unionfs

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

import { ufs } from 'unionfs';
import { fs as fs1 } from 'memfs';
import * as fs2 from 'fs';

ufs.use(fs1).use(fs2);

ufs.readFileSync(/* ... */);

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

You can also use other fs-like objects.

import * as fs from 'fs';
import { Volume } from 'memfs';
import * as MemoryFileSystem from 'memory-fs';
import { ufs } from 'unionfs';

const vol1 = Volume.fromJSON({ '/memfs-1': '1' });
const vol2 = Volume.fromJSON({ '/memfs-2': '2' });

const memoryFs = new MemoryFileSystem();
memoryFs.writeFileSync('/memory-fs', '3');

ufs.use(fs).use(vol1).use(vol2).use(memoryFs);

console.log(ufs.readFileSync('/memfs-1', 'utf8')); // 1
console.log(ufs.readFileSync('/memfs-2', 'utf8')); // 2
console.log(ufs.readFileSync('/memory-fs', 'utf8')); // 3

You can create a Union instance manually:

import { Union } from 'unionfs';

var ufs1 = new Union();
ufs1.use(fs).use(vol);

var ufs2 = new Union();
ufs2.use(fs).use(/*...*/);

License

Unlicense - public domain.

版本列表

4.6.0 2025-07-18

4.5.4 2024-03-19

4.5.3 2024-03-19

4.5.2 2024-03-19

4.5.1 2023-06-03

4.5.0 2023-06-02

4.4.0 2020-03-12

4.3.2 2020-02-17

4.3.1 2020-02-15

4.3.0 2020-02-15

4.2.1 2019-12-19

4.2.0 2019-03-02

4.1.0 2019-03-01

4.0.0 2019-01-30

3.0.2 2017-12-08

3.0.1 2017-12-01

2.0.7 2017-10-22

2.0.4 2017-10-22

2.0.3 2017-08-13

2.0.2 2017-08-13

2.0.1 2017-08-13

2.0.0 2017-08-13

0.0.9 2016-05-16

0.0.8 2016-05-16

0.0.6 2015-07-03

0.0.5 2015-06-15

0.0.4 2015-06-15

0.0.3 2015-06-15

0.0.2 2015-06-15

0.0.1 2015-06-14