redux-replicate-fs

Replicator for redux-replicate designed to locally persist the state of redux stores using fs.

Table of contents

1. Installation
2. Usage
3. Example using react-redux-provide
4. Example using compose
5. Debouncing

Installation

npm install redux-replicate-fs --save

Usage

Note: This is currently intended only for demonstration purposes! Don't use this in production. At some point we may turn this into a proper flatfile storage system though! :)

Use with redux-replicate.

Example using react-redux-provide

1// src/replication.js
2
3import fs from 'redux-replicate-fs';
4import { theme } from './providers/index';
5
6theme.replication = {
7  reducerKeys: ['themeName'],
8  replicator: fs
9};

Example using compose

1import { createStore, combineReducers, compose } from 'redux';
2import replicate from 'redux-replicate';
3import fs from 'redux-replicate-fs';
4import reducers from './reducers';
5
6const initialState = {
7  wow: 'such storage',
8  very: 'cool'
9};
10
11const key = 'superCoolStorageUnit';
12const reducerKeys = true;
13const replicator = fs;
14const replication = replicate({ key, reducerKeys, replicator });
15const create = compose(replication)(createStore);
16const store = create(combineReducers(reducers), initialState);

Debouncing

By default, a debounce occurs when writing the next state to the file system (during onStateChange). The default timeout is 1 millisecond. You can change it by doing this:

1import fs from 'redux-replicate-fs';
2
3fs.debounce = 20;