fs-restore

Take a snapshot of a file or folder to later restore it.

Usage

1var snapshot = require('fs-restore')
2
3// take a snapshot of /src folder
4
5var s = snapshot('/src')
6
7// do whatever you want to the folder (delete it for example)
8
9// restore it at the point when the snapshot was taken
10s.restore()

API

var s = snapshot(path)

A function that expect the path of the file or folder to be restored later. Returns an object with a data object property and a restore function property.

s.data

An object with the representation of the folder. It is a tree data structure, each node has a type property. If type equals 'file', it also has a property data with the file contents as a stream. If type equals 'dir', it has a children property which is an object and each property of this object is the name of the file/path in this directory. So, suppose this file structure:

public/
├── images/
│   ├── img01.png
│   └── img01.png
├── data.txt
└── data.log

The object that would represent this directory would be like this

1var publicFs = {
2  type: 'dir',
3  children: {
4    'images': {
5      type: 'dir',
6      children: {
7        'img01.png': {
8          type: 'file',
9          data: '...' // ReadStream
10        },
11        'img02.png': {
12          type: 'file',
13          data: '...' // ReadStream
14        }
15      }
16    },
17    'data.txt': {
18      type: 'file',
19      data: '...' // ReadStream
20    },
21    'data.log': {
22      type: 'file',
23      data: '...' // ReadStream
24    }
25  }
26}

s.restore()

Restore the folder at the pointe described by s.data.

Install

1$ npm install fs-restore

TODO

• Add an option to specify a datastore, like memdb, to make restores even when the current program is finished or killed.

1var snapshot = require('fs-restore')
2
3var s = snapshot('/src', { db: require('memdb')() })
4
5// in other program or node instance
6var snapshot = require('fs-restore')
7
8var s = snapshot('/src').restore()

• Handle sync and async versions.

License

MIT © Yerko Palma.