Skip to content

Commit 0dfd7bb

Browse files
committed
docs: ✏️ describe memfs() helper in docs
[skip ci]
1 parent 0509f15 commit 0dfd7bb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/node/usage.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ vol.writeFileSync('/foo', 'bar');
3939
expect(vol.toJSON()).toEqual({ '/foo': 'bar' });
4040
```
4141

42+
Construct new `memfs` volumes:
43+
44+
```js
45+
import { memfs } from 'memfs';
46+
47+
const { fs, vol } = memfs({ '/foo': 'bar' });
48+
49+
fs.readFileSync('/foo', 'utf8'); // bar
50+
```
51+
4252
Create as many filesystem volumes as you need:
4353

4454
```js

0 commit comments

Comments
 (0)