• Stars
    star
    2,499
  • Rank 18,382 (Top 0.4 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A mock store for testing Redux async action creators and middleware.

redux-mock-store Circle CI

npm

A mock store for testing Redux async action creators and middleware. The mock store will create an array of dispatched actions which serve as an action log for tests.

Please note that this library is designed to test the action-related logic, not the reducer-related one. In other words, it does not update the Redux store. If you want a complex test combining actions and reducers together, take a look at other libraries (e.g., redux-actions-assertions). Refer to issue #71 for more details.

Install

npm install redux-mock-store --save-dev

Or

yarn add redux-mock-store --dev

Usage

Synchronous actions

The simplest usecase is for synchronous actions. In this example, we will test if the addTodo action returns the right payload. redux-mock-store saves all the dispatched actions inside the store instance. You can get all the actions by calling store.getActions(). Finally, you can use any assertion library to test the payload.

import configureStore from 'redux-mock-store' //ES6 modules
const { configureStore } = require('redux-mock-store') //CommonJS

const middlewares = []
const mockStore = configureStore(middlewares)

// You would import the action from your codebase in a real scenario
const addTodo = () => ({ type: 'ADD_TODO' })

it('should dispatch action', () => {

  // Initialize mockstore with empty state
  const initialState = {}
  const store = mockStore(initialState)

  // Dispatch the action
  store.dispatch(addTodo())

  // Test if your store dispatched the expected actions
  const actions = store.getActions()
  const expectedPayload = { type: 'ADD_TODO' }
  expect(actions).toEqual([expectedPayload])
})

Asynchronous actions

A common usecase for an asynchronous action is a HTTP request to a server. In order to test those types of actions, you will need to call store.getActions() at the end of the request.

import configureStore from 'redux-mock-store'
import thunk from 'redux-thunk'

const middlewares = [thunk] // add your middlewares like `redux-thunk`
const mockStore = configureStore(middlewares)

// You would import the action from your codebase in a real scenario
function success() {
  return {
    type: 'FETCH_DATA_SUCCESS'
  }
}

function fetchData () {
  return dispatch => {
    return fetch('/users.json') // Some async action with promise
      .then(() => dispatch(success()))
  };
}

it('should execute fetch data', () => {
  const store = mockStore({})

  // Return the promise
  return store.dispatch(fetchData())
    .then(() => {
      const actions = store.getActions()
      expect(actions[0]).toEqual(success())
    })
})

API

configureStore(middlewares?: Array) => mockStore: Function

Configure mock store by applying the middlewares.

mockStore(getState?: Object,Function) => store: Function

Returns an instance of the configured mock store. If you want to reset your store after every test, you should call this function.

store.dispatch(action) => action

Dispatches an action through the mock store. The action will be stored in an array inside the instance and executed.

store.getState() => state: Object

Returns the state of the mock store.

store.getActions() => actions: Array

Returns the actions of the mock store.

store.clearActions()

Clears the stored actions.

store.subscribe(callback: Function) => unsubscribe: Function

Subscribe to the store.

store.replaceReducer(nextReducer: Function)

Follows the Redux API.

Old version (< 1.x.x)

https://github.com/arnaudbenard/redux-mock-store/blob/v0.0.6/README.md

Versions

The following versions are exposed by redux-mock-store from the package.json:

  • main: commonJS Version
  • module/js:next: ES Module Version
  • browser : UMD version

License

The MIT License

More Repositories

1

redux

A JS library for predictable global state management
TypeScript
60,801
star
2

react-redux

Official React bindings for Redux
TypeScript
23,324
star
3

reselect

Selector library for Redux
TypeScript
19,023
star
4

redux-thunk

Thunk middleware for Redux
TypeScript
17,764
star
5

redux-devtools

DevTools for Redux with hot reloading, action replay, and customizable UI
TypeScript
14,040
star
6

redux-toolkit

The official, opinionated, batteries-included toolset for efficient Redux development
TypeScript
10,605
star
7

redux-templates

Official Redux templates for Vite, Create-React-App, and more
TypeScript
1,395
star
8

cra-template-redux

ARCHIVED: the CRA+JS template has moved to https://github.com/reduxjs/redux-templates
JavaScript
1,270
star
9

redux-essentials-example-app

Example app for the Redux Essentials tutorial
CSS
299
star
10

redux-devtools-chart-monitor

A chart monitor for Redux DevTools https://www.npmjs.com/package/redux-devtools-chart-monitor
JavaScript
293
star
11

rtk-github-issues-example

Source code for the Redux Toolkit Advanced Tutorial
TypeScript
215
star
12

d3-state-visualizer

Real-time visualizations of your application state
JavaScript
104
star
13

rtk-convert-todos-example

Source code for the Toolkit Intermediate Tutorial
JavaScript
93
star
14

redux-fundamentals-example-app

Example app for the Redux Fundamentals tutorial
CSS
80
star
15

angular-redux

Official Angular bindings for Redux
TypeScript
71
star
16

react-redux-benchmarks

Performance benchmark harness for React-Redux
TypeScript
70
star
17

redux-essentials-counter-example

The standard Redux / Redux Toolkit "counter" app template for Create React App
JavaScript
47
star
18

examples

Examples of how to use Redux.
JavaScript
41
star
19

vue-redux

Official Vue bindings for Redux
TypeScript
19
star