# use-reducer-persisted

> useReducer hook with persistence in storage

Latest version **1.2.1** (published 2021-05-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install use-reducer-persisted
pnpm add use-reducer-persisted
yarn add use-reducer-persisted
bun add use-reducer-persisted
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2021-05-09 |
| First published | 2020-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 18.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Vahid Khakestani |
| Maintainers | khakestani |
| Keywords | React, useReducer, persisted, localStorage, sessionStorage, cookie, storage, persisted state, state, dispatch, reducer |

## Links

- npm: https://www.npmjs.com/package/use-reducer-persisted
- Repository: https://github.com/khakestani/use-reducer-persisted
- Homepage: https://github.com/khakestani/use-reducer-persisted#readme
- Issues: https://github.com/khakestani/use-reducer-persisted/issues
- npm.io page: https://npm.io/package/use-reducer-persisted

## Dependencies (2)

- [babel-loader](https://npm.io/package/babel-loader.md) ^8.1.0
- [universal-cookie](https://npm.io/package/universal-cookie.md) ^4.0.4

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2021-05-09
- 1.2.0 — 2020-10-26
- 1.1.0 — 2020-10-26

## README

# use-reducer-persisted

Easily Persist your state created by useReducer into ( localStorage | sessionStorage | cookie ) and keep it sync in different tabs/windows

## Features :boom::fire:
<h3>1- Three different storage</h3> Store your state in 3 different storage such as

- localStorage
- sessionStorage
- cookie :flushed:
<h3>2- Synced State :</h3>
 Your state will be synced at all Window/Tap for a same browser ( even in cookie ) 


## Requirement
To use `use-reducer-persisted`, you must use `react@16.8.0` or greater which includes Hooks.

<h2>Using</h2>

first import it

```javascript
import useReducerPersisted from 'use-reducer-persisted';
```

And then easily use it like useReducer , Just some more arguments :smile:

```javascript
const [state, dispatch] = useReducerPersisted(key, reducer, init, storage, options);
```
****key :**** your storage key  like "userInfo" ( Required )  
****reducer :**** your reducer ( Required )  
****init :**** your initial state as value or callback function  
****storage :**** specify storage type as string ( `"local"` for localStorage, `"session"` for sessionStorage , `"cookie"` for cookie )  
***options :*** all options for your cookie and syncing time interval for cookie :  
  - step : interval time in milisecond for syncing state from cookie on other tab/window
  - other option of cookie based on ["universal-cookie"](https://www.npmjs.com/package/universal-cookie)




<h2> Example </h2>

```javascript
import useReducerPersisted from 'use-reducer-persisted';
import reducer from './path/to/yourReducer';

function Counter() {
  const [state, dispatch] = useReducerPersisted('counter', reducer, initialState);
  return (
    <>
      Count: {state.count}
      <button onClick={() => dispatch({type: 'decrement'})}>-</button>
      <button onClick={() => dispatch({type: 'increment'})}>+</button>
    </>
  );
}
```
> Taken from the basic example of React [useReducer](https://reactjs.org/docs/hooks-reference.html#usereducer)


- The state created by this hook is shared for this App on other tabs or windows

- Even when you close the window completely and open it again your state is persisted

### Licence 
 [MIT](https://github.com/khakestani/use-reducer-persisted/blob/main/LICENSE) Licensed

---
_Source: https://npm.io/package/use-reducer-persisted · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._