You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
1.0 KiB
45 lines
1.0 KiB
3 years ago
|
mem-fs
|
||
|
|
=============
|
||
|
|
|
||
|
|
Simple in-memory vinyl file store.
|
||
|
|
|
||
|
|
|
||
|
|
Usage
|
||
|
|
-------------
|
||
|
|
|
||
|
|
### Loading a file
|
||
|
|
|
||
|
|
You access a file using `store#get()` method. If the file is in memory, it will be used. Otherwise, we'll load the file from the file-system.
|
||
|
|
|
||
|
|
```js
|
||
|
|
var store = require('mem-fs').create();
|
||
|
|
|
||
|
|
store.get('/test/file.txt');
|
||
|
|
```
|
||
|
|
|
||
|
|
When trying to load a file we cannot read from disk, an empty Vinyl file will be returned. The `contents` of this file will be set to `null`.
|
||
|
|
|
||
|
|
Trying to get a directory or any invalid files will also return an empty Vinyl file pointer.
|
||
|
|
|
||
|
|
### Adding/updating a file
|
||
|
|
|
||
|
|
You update file references by using `store#add()` method. This method take a `vinyl` file object as parameter.
|
||
|
|
|
||
|
|
```js
|
||
|
|
var File = require('vinyl');
|
||
|
|
var store = require('mem-fs').create();
|
||
|
|
|
||
|
|
var coffeeFile = new File({
|
||
|
|
cwd: '/',
|
||
|
|
base: '/test/',
|
||
|
|
path: '/test/file.coffee',
|
||
|
|
contents: new Buffer('test = 123')
|
||
|
|
});
|
||
|
|
|
||
|
|
store.add(coffeeFile);
|
||
|
|
```
|
||
|
|
|
||
|
|
### Iterating over the file system
|
||
|
|
|
||
|
|
Using `store#each(cb(file, index))`, you can iterate over every file stored in the file system.
|