# redux-test-utils

## redux-test-utils Package Description

Testing utility to use with `createReducer` from [redux-starter-kit](https://github.com/reduxjs/redux-starter-kit).

## Getting Started

```shell
yarn add -D @appia/redux-test-utils
npm i --dev @appia/redux-test-utils
```

## API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

#### Table of Contents

- [redux-test-utils](#redux-test-utils)
  - [redux-test-utils Package Description](#redux-test-utils-package-description)
  - [Getting Started](#getting-started)
  - [API](#api)
      - [Table of Contents](#table-of-contents)
    - [itTestsCreateReducers](#ittestscreatereducers)
      - [Parameters](#parameters)
      - [Examples](#examples)

### itTestsCreateReducers

Helper to test reducers created with redux-starter-kit !

#### Parameters

-   `reducer`  
-   `initialState`  

#### Examples

```javascript
const action1 = createAction('ACTION1');
const action2 = createAction('ACTION2');
const initialState = { test: '' };

const reducers = createReducer(initialState, {
 [action1]: (state, payload) => ({ ... }),
 [action2]: (state, payload) => ({ ... })
});
const itShouldRetunsCorrectResults = itTestsCreateReducers(reducers, initialState);
itShouldRetunsCorrectResults({
  action: action1,
  mutations: [{
    name: 'Assoc action 1',
    props: {
      name: 'test'
    },
  }],
});
```

Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** itShouldRetunsCorrectResults