README.md

Percyst

An unopinionated Redux store persistor with optional encryption that works out of the box

🏠 Homepage

Why?

Percyst was created to respond to an urgent need of a Redux middleware which can work right away without fancy or overengineered boilerplate.

After trying couple of other libraries which unnecessarily made that task difficult while at the same time contributed with some units of ugliness to the store initialization procedure, I decided to go on with my own solution.

Now my code looks cleaner and compact.

About

Percyst will preserve your Redux state using the browser's local storage.

Aditionally, you can choose to encrypt the state using AES cryptography without anything else other than setting an additional property. Also, you can choose to ignore some keys from your state to avoid storing them.

Install

yarn add percyst

or

npm i percyst

Usage

A quick overview of my current configureStore.js file:

import { applyMiddleware, createStore } from "redux";
import { rootReducer } from "../reducers";
import { Percyst } from "percyst";

const percyst = new Percyst();

export default function configureStore(initialState) {
  return createStore(
    rootReducer,
    percyst.rehydrate(initialState),
    applyMiddleware(percyst.middleware)
  );
}

After instantiating the Percyst object, inject the middleware using the corresponding middleware method as shown above. Finally, as a second argument to the Redux's createStore utility (*preloadedState), use Percyst's rehydrate method along with an optional initial state object.

Options

Just in case, you can enable encryption, ignore some pieces of your state or if you just want to reset the state after a certain period (e.g. destroy session and logout a user). Use these options using the Percyst constructor:

const percyst = new Percyst({
  ignore: ["loginError"],
  encryptSecret: "p4ssphr4s3",
});

Option	Type	Description	Required
ignore	Array	A list of keys that will not be saved	No
encryptSecret	String	Enables encryption of the state using this passphrase	No
ttl	Number	Time to live in milliseconds. The amount of time the state can persist in the storage.	No

Author

👤 Nicolas Iglesias

• Website: https://github.com/QAlfy/percyst
• Github: @webpolis

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Nicolas Iglesias.
This project is MIT licensed.