# redux-utility-belt

> Redux utility functions

Latest version **0.0.14** (published 2019-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install redux-utility-belt
pnpm add redux-utility-belt
yarn add redux-utility-belt
bun add redux-utility-belt
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.14 |
| Published | 2019-06-25 |
| First published | 2018-01-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.0.0 |
| Dependencies | 1 |
| Unpacked size | 237.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Mahdi Pourismaiel |
| Maintainers | mahdiponline |
| Keywords | redux, saga |

## Links

- npm: https://www.npmjs.com/package/redux-utility-belt
- Repository: git@github.com:mpourismaiel/redux-utility-belt
- npm.io page: https://npm.io/package/redux-utility-belt

## Dependencies (1)

- [@types/redux](https://npm.io/package/@types/redux.md) ^3.6.0

## Recent versions

- 0.0.14 (latest) — 2019-06-25
- 0.0.13 — 2019-06-22
- 0.0.12 — 2019-06-21
- 0.0.11 — 2019-05-14
- 0.0.10 — 2019-05-08
- 0.0.9 — 2019-05-08
- 0.0.8 — 2019-05-08
- 0.0.7 — 2019-05-08
- 0.0.6 — 2019-05-07
- 0.0.5 — 2019-04-22
- 0.0.4 — 2019-04-08
- 0.0.3 — 2019-03-20
- 0.0.2 — 2019-03-17
- 0.0.1 — 2019-03-17
- 1.1.0 — 2018-06-14
- … 1 more at https://npm.io/package/redux-utility-belt/versions

## README

# Redux utility belt

A bunch of functions to make writing reducers, action creators and making API calls a bit less tedious.

## Usage

Install the library by running:

```
yarn add redux-utility-belt
```

### Making API calls

You need to add the restSaga and set axios (or any other function that receives a `config` object containing `url`, `data` and `config` as their arguments):

```
import { restSagas, setFetchAlt } from 'redux-utility-belt';

...
sagaMiddleware.run(restSagas);
```

In order to make API calls, create an action. The action type must be the result of calling one of the rest action type:

```
import { postType, putType, getType, deleteType } from 'redux-utility-belt';

export const LOGIN = 'AUTH/LOGIN';

export const login = ({ email, password }) => ({
  type: postType(LOGIN),
  payload: { data: { email, password }, baseType: LOGIN, url: '/login' },
});
```

You can also pass callbacks to `callback.onSuccess` and `callback.onFailure`.

### Creating reducers

Reducers created by the utility belt are made to work with the restSaga. So in order to make it easier to make API calls, the reducer object passed to the function has 5 keys: `get`, `post`, `put`, `delete`, `none`. The action is passed to `none` object if `action.type` is not the result of calling one of the rest action types.

Rest types in the reducer have three types: `request`, `success` or `failure`.

```
import { postType, createReducer } from 'redux-utility-belt';
import { Dictionary } from '../../types';

// Constants
export const LOGIN = 'AUTH/LOGIN';

// Action Creators
export const login = ({ email, password }) => ({
  type: postType(LOGIN),
  payload: { data: { email, password }, baseType: LOGIN, url: '/login' },
});

// Reducer
export interface AuthState {
  isLoggingIn: boolean;
  user: Dictionary<any>;
  token: null | string;
  error: null | string;
}

const token = localStorage.getItem('auth_token');
export const initialState: AuthState = {
  isLoggingIn: token !== 'undefined' && token !== undefined && token !== null,
  user: {},
  token: token === 'undefined' ? null : token || null,
  error: null,
};

const auth = createReducer<AuthState>(initialState, {
  post: {
    [LOGIN]: {
      request: state => ({ ...state, isLoggingIn: true, error: null }),
      failure: (state, action) => ({
        ...state,
        isLoggingIn: false,
        error: action.payload,
      }),
      success: (state, { payload: { token, ...user } }) => {
        localStorage.setItem('auth_token', token);
        return {
          ...state,
          isLoggingIn: false,
          user,
          token,
        };
      },
    },
  },
});
```

Created using the fantastic [TypeScript library starter](https://github.com/alexjoverm/typescript-library-starter)

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