A fork of redux allowing opt-out of the ban on sideeffects in the reducer

Have you also had errors come up once upgrading redux to 4.0, that you cant use getState, dispatch or subscribe /unsubscribe in the reducer?

Its a complete antipattern indeed, but as it turns out theres at least currently no technical reason to forbid that usage.

It might break some middleware now or in the future, but theres nothing speaking against continuing to allow this usage as opt-in with heavy warnings, as lots of legacy codebases, the one I came into a few months ago unfortunately included, rely on these antipatterns.

And the build-in resources from redux, like combineReducers, dont allow for in-pattern usage of global redux-state in your small reducers.

So I put in the work to design a way to opt-out of this ban with out breaking anything and minimal exclusion of future expansion of the API of createStore, to document these changes, write the tests, and make a merge-request.

In said merge-request I also said that I could work on adding the global State as 3rd parameter of reducers in combineReducers.

This was THE SUGGESTED WAY to use global state in reducers in the VERY commit that banned the usage of getState, and it doesnt neccesarily lead to a large interwoven state thats hard to understand. Limiting the potential influencers from the global state to that of single reducers is as easy as using object destructuring in the parameter of the reducer, or extracting the state you need and then not using the global state anymore. But as it turns out the maintainers were interested neither in my merge-request nor supporting in-pattern usage of global state in the reducers by adding a 3rd parameter to combineReducers.

I might not have been the calmest person in the discussion, but they gave barely any argmuents for their complete dismissal of the possibility to allow continued guarded access to an antipattern they never actively warned against, i.e. by console.warn-ing, in the past. Said antipattern is only ever used because of their stubborn dismissal of expanding the functionality of their code like in the combineReducer case. I guess theres a reason that Vuex is far superior to Redux, but as I'm stuck with redux and already put in the work I though that maybe someone else would be interested in my modification and decided to publish this on NPM.

I can only say to any person still deciding on a state management, choose vuex. I have no experience with that package, but react-vuex promises a way to use Vuex with React simularly to redux with react-redux. The disadvantage of that is that you have to include Vue in addition to React and Vuex - unless you switch to Vue -, but Vue comes with a decently small codebasis on its own.

This redux-fork is meant for those stuck with redux like me but wanting to use newer features. If noone else is interested it'll at least ease access to this code in my project, if there is I'd love some support in keeping this code-basis up to date with changes in redux.

The API of the modified createStore:

createStore(reducer, [preloadedState], [enhancer])

Creates a Redux store that holds the complete state tree of your app.
There should only be a single store in your app.

Arguments

1. reducer (Function): A reducing function that returns the next state tree, given the current state tree and an action to handle.

2. [preloadedState] (any): The initial state. You may optionally specify it to hydrate the state from the server in universal apps, or to restore a previously serialized user session. If you produced reducer with combineReducers, this must be a plain object with the same shape as the keys passed to it. Otherwise, you are free to pass anything that your reducer can understand.

3. [enhancer] (Function): The store enhancer. You may optionally specify it to enhance the store with third-party capabilities such as middleware, time travel, persistence, etc. The only store enhancer that ships with Redux is applyMiddleware().

4. [options] (object): Optional object with further configuration of redux. Currently allows for opt out of the ban on getState, dispatch and subscriptionhandling in the reducer via the boolean parameters rules.allowDispatch, rules.allowGetState and rules.allowSubscriptionHandling. Keep in mind though that this ban is there for a reason, and this opt-out is meant for compatibility with legacy-code. Using these functions in the reducer is an antipattern that makes the reducer impure, and support for this might be removed in the future.

Returns

(Store): An object that holds the complete state of your app. The only way to change its state is by dispatching actions. You may also subscribe to the changes to its state to update the UI.

Example

import { createStore, applyMiddleware } from 'redux'
import thunkMiddleware from 'redux-thunk';

const todos = (state = [], action) => {
  switch (action.type) {
    case 'ADD_TODO':
      store.getState();
      return state.concat([action.text]);
    default:
      return state
  }
}

// needs `undefined` or a function -store enhancer aka middleware like redux-thunk - bevor it to distinguish between the initialState and the options object
const store = createStore(todos, ['Better use Vue'], undefined, {rules: { allowGetState: true } })

// so this works too:
const store2 = createStore(todos, ['Better use Vue'], applyMiddleware(thunkMiddleware), {rules: { allowDispatch: true } })

// and this: 
const store3 = createStore(todos, applyMiddleware(thunkMiddleware), {rules: { allowSubscriptionHandling: true } })

// and this:
const store4 = createStore(todos, undefined, {rules: { allowGetState: true } })

store.dispatch({
  type: 'ADD_TODO',
  text: ' in the future'
})

console.log(store.getState())
// [ 'Better use Vue', ' in the future' ]

Tips

• Don't create more than one store in an application! Instead, use combineReducers to create a single root reducer out of many.

• It is up to you to choose the state format. You can use plain objects or something like Immutable. If you're not sure, start with plain objects.

• If your state is a plain object, make sure you never mutate it! For example, instead of returning something like Object.assign(state, newData) from your reducers, return Object.assign({}, state, newData). This way you don't override the previous state. You can also write return { ...state, ...newData } if you enable the object spread operator proposal.

• For universal apps that run on the server, create a store instance with every request so that they are isolated. Dispatch a few data fetching actions to a store instance and wait for them to complete before rendering the app on the server.

• When a store is created, Redux dispatches a dummy action to your reducer to populate the store with the initial state. You are not meant to handle the dummy action directly. Just remember that your reducer should return some kind of initial state if the state given to it as the first argument is undefined, and you're all set.

• To apply multiple store enhancers, you may use compose().

Other notes

Typescripy typing for the extended createReducer is of course provided.

I might add the global state as 3rd optional argument to reducers combined with createReducer in this package.

Redux is a predictable state container for JavaScript apps.
(Not to be confused with a WordPress framework – Redux Framework.)

It helps you write applications that behave consistently, run in different environments (client, server, and native), and are easy to test. On top of that, it provides a great developer experience, such as live code editing combined with a time traveling debugger.

You can use Redux together with React, or with any other view library.
It is tiny (2kB, including dependencies).

Note: We are currently planning a rewrite of the Redux docs. Please take some time to fill out this survey on what content is most important in a docs site. Thanks!

Learn Redux

We have a variety of resources available to help you learn Redux, no matter what your background or learning style is.

Just the Basics

If you're brand new to Redux and want to understand the basic concepts, see:

• The Motivation behind building Redux, the Core Concepts, and the Three Principles.
• The basic tutorial in the Redux docs
• Redux creator Dan Abramov's free "Getting Started with Redux" video series on Egghead.io
• Redux co-maintainer Mark Erikson's "Redux Fundamentals" slideshow and list of suggested resources for learning Redux
• If you learn best by looking at code and playing with it, check out our list of Redux example applications, available as separate projects in the Redux repo, and also as interactive online examples on CodeSandbox.
• The Redux Tutorials section of the React/Redux links list. Here's a top list of our recommended tutorials:
  • Dave Ceddia's posts What Does Redux Do? (and when should you use it?) and How Redux Works: A Counter-Example are a great intro to the basics of Redux and how to use it with React, as is this post on React and Redux: An Introduction.
  • Valentino Gagliardi's post React Redux Tutorial for Beginners: Learning Redux in 2018 is an excellent extended introduction to many aspects of using Redux.
  • The CSS Tricks article Leveling Up with React: Redux covers the Redux basics well.
  • This DevGuides: Introduction to Redux tutorial covers several aspects of Redux, including actions, reducers, usage with React, and middleware.

Intermediate Concepts

Once you've picked up the basics of working with actions, reducers, and the store, you may have questions about topics like working with asynchronous logic and AJAX requests, connecting a UI framework like React to your Redux store, and setting up an application to use Redux:

• The "Advanced" docs section covers working with async logic, middleware, routing.
• The Redux docs "Learning Resources" page points to recommended articles on a variety of Redux-related topics.
• Sophie DeBenedetto's 8-part Building a Simple CRUD App with React + Redux series shows how to put together a basic CRUD app from scratch.

Real-World Usage

Going from a TodoMVC app to a real production application can be a big jump, but we've got plenty of resources to help:

• Redux creator Dan Abramov's free "Building React Applications with Idiomatic Redux" video series builds on his first video series and covers topics like middleware, routing, and persistence.
• The Redux FAQ answers many common questions about how to use Redux, and the "Recipes" docs section has information on handling derived data, testing, structuring reducer logic, and reducing boilerplate.
• Redux co-maintainer Mark Erikson's "Practical Redux" tutorial series demonstrates real-world intermediate and advanced techniques for working with React and Redux (also available as an interactive course on Educative.io).
• The React/Redux links list has categorized articles on working with reducers and selectors, managing side effects, Redux architecture and best practices, and more.
• Our community has created thousands of Redux-related libraries, addons, and tools. The "Ecosystem" docs page lists our recommendations, and there's a complete listing available in the Redux addons catalog.
• If you're looking to learn from actual application codebases, the addons catalog also has a list of purpose-built examples and real-world applications.

Finally, Mark Erikson is teaching a series of Redux workshops through Workshop.me. Check the workshop schedule for upcoming dates and locations.

Help and Discussion

The #redux channel of the Reactiflux Discord community is our official resource for all questions related to learning and using Redux. Reactiflux is a great place to hang out, ask questions, and learn - come join us!

Before Proceeding Further

Redux is a valuable tool for organizing your state, but you should also consider whether it's appropriate for your situation. Don't use Redux just because someone said you should - take some time to understand the potential benefits and tradeoffs of using it.

Here are some suggestions on when it makes sense to use Redux:

• You have reasonable amounts of data changing over time
• You need a single source of truth for your state
• You find that keeping all your state in a top-level component is no longer sufficient

Yes, these guidelines are subjective and vague, but this is for good reason. The point at which you should integrate Redux into your application is different for every user and different for every application.

For more thoughts on how Redux is meant to be used, see:

• You Might Not Need Redux
• The Tao of Redux, Part 1 - Implementation and Intent
• The Tao of Redux, Part 2 - Practice and Philosophy
• Redux FAQ

Developer Experience

Dan Abramov (author of Redux) wrote Redux while working on his React Europe talk called “Hot Reloading with Time Travel”. His goal was to create a state management library with a minimal API but completely predictable behavior. Redux makes it possible to implement logging, hot reloading, time travel, universal apps, record and replay, without any buy-in from the developer.

Influences

Redux evolves the ideas of Flux, but avoids its complexity by taking cues from Elm.
Even if you haven't used Flux or Elm, Redux only takes a few minutes to get started with.

Installation

To install the stable version:

npm install --save redux

This assumes you are using npm as your package manager.

If you're not, you can access these files on unpkg, download them, or point your package manager to them.

Most commonly, people consume Redux as a collection of CommonJS modules. These modules are what you get when you import redux in a Webpack, Browserify, or a Node environment. If you like to live on the edge and use Rollup, we support that as well.

If you don't use a module bundler, it's also fine. The redux npm package includes precompiled production and development UMD builds in the dist folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. For example, you can drop a UMD build as a <script> tag on the page, or tell Bower to install it. The UMD builds make Redux available as a window.Redux global variable.

The Redux source code is written in ES2015 but we precompile both CommonJS and UMD builds to ES5 so they work in any modern browser. You don't need to use Babel or a module bundler to get started with Redux. You can even use the ES module build that's available at es/redux.mjs which can be referenced using type="module" in your script tag or as a standard import.

Complementary Packages

Most likely, you'll also need the React bindings and the developer tools.

npm install --save react-redux
npm install --save-dev redux-devtools

Note that unlike Redux itself, many packages in the Redux ecosystem don't provide UMD builds, so we recommend using CommonJS module bundlers like Webpack and Browserify for the most comfortable development experience.

The Gist

The whole state of your app is stored in an object tree inside a single store.
The only way to change the state tree is to emit an action, an object describing what happened.
To specify how the actions transform the state tree, you write pure reducers.

That's it!

import { createStore } from 'redux'

/**
 * This is a reducer, a pure function with (state, action) => state signature.
 * It describes how an action transforms the state into the next state.
 *
 * The shape of the state is up to you: it can be a primitive, an array, an object,
 * or even an Immutable.js data structure. The only important part is that you should
 * not mutate the state object, but return a new object if the state changes.
 *
 * In this example, we use a `switch` statement and strings, but you can use a helper that
 * follows a different convention (such as function maps) if it makes sense for your
 * project.
 */
function counter(state = 0, action) {
  switch (action.type) {
    case 'INCREMENT':
      return state + 1
    case 'DECREMENT':
      return state - 1
    default:
      return state
  }
}

// Create a Redux store holding the state of your app.
// Its API is { subscribe, dispatch, getState }.
let store = createStore(counter)

// You can use subscribe() to update the UI in response to state changes.
// Normally you'd use a view binding library (e.g. React Redux) rather than subscribe() directly.
// However it can also be handy to persist the current state in the localStorage.

store.subscribe(() => console.log(store.getState()))

// The only way to mutate the internal state is to dispatch an action.
// The actions can be serialized, logged or stored and later replayed.
store.dispatch({ type: 'INCREMENT' })
// 1
store.dispatch({ type: 'INCREMENT' })
// 2
store.dispatch({ type: 'DECREMENT' })
// 1

Instead of mutating the state directly, you specify the mutations you want to happen with plain objects called actions. Then you write a special function called a reducer to decide how every action transforms the entire application's state.

If you're coming from Flux, there is a single important difference you need to understand. Redux doesn't have a Dispatcher or support many stores. Instead, there is just a single store with a single root reducing function. As your app grows, instead of adding stores, you split the root reducer into smaller reducers independently operating on the different parts of the state tree. This is exactly like how there is just one root component in a React app, but it is composed out of many small components.

This architecture might seem like an overkill for a counter app, but the beauty of this pattern is how well it scales to large and complex apps. It also enables very powerful developer tools, because it is possible to trace every mutation to the action that caused it. You can record user sessions and reproduce them just by replaying every action.

Learn Redux from Its Authors

Redux Video Tutorials by Dan Abramov

Getting Started with Redux

Getting Started with Redux is a video course consisting of 30 videos narrated by Dan Abramov, author of Redux. It is designed to complement the “Basics” part of the docs while bringing additional insights about immutability, testing, Redux best practices, and using Redux with React. This course is free and will always be.

“Great course on egghead.io by @dan_abramov - instead of just showing you how to use #redux, it also shows how and why redux was built!”
Sandrino Di Mattia

“Plowing through @dan_abramov 'Getting Started with Redux' - its amazing how much simpler concepts get with video.”
Chris Dhanaraj

“This video series on Redux by @dan_abramov on @eggheadio is spectacular!”
Eddie Zaneski

“Come for the name hype. Stay for the rock solid fundamentals. (Thanks, and great job @dan_abramov and @eggheadio!)”
Dan

“This series of videos on Redux by @dan_abramov is repeatedly blowing my mind - gunna do some serious refactoring”
Laurence Roberts

So, what are you waiting for?

Watch the free "Getting Started with Redux" video series

Note: If you enjoyed Dan's course, consider supporting Egghead by buying a subscription. Subscribers have access to the source code of every example in my videos and tons of advanced lessons on other topics, including JavaScript in depth, React, Angular, and more. Many Egghead instructors are also open source library authors, so buying a subscription is a nice way to thank them for the work that they've done.

Building React Applications with Idiomatic Redux

The Building React Applications with Idiomatic Redux course is a second free video series by Dan Abramov. It picks up where the first series left off, and covers practical production ready techniques for building your React and Redux applications: advanced state management, middleware, React Router integration, and other common problems you are likely to encounter while building applications for your clients and customers. As with the first series, this course will always be free.

Watch the free "Idiomatic Redux" video series

Practical Redux course

Practical Redux is a paid interactive course by Redux co-maintainer Mark Erikson. The course is designed to show how to apply the basic concepts of Redux to building something larger than a TodoMVC application. It includes real-world topics like:

• Adding Redux to a new Create-React-App project and configuring Hot Module Replacement for faster development
• Controlling your UI behavior with Redux
• Using the Redux-ORM library to manage relational data in your Redux store
• Building a master/detail view to display and edit data
• Writing custom advanced Redux reducer logic to solve specific problems
• Optimizing performance of Redux-connected form inputs

And much more!

The course is based on Mark's original free "Practical Redux" blog tutorial series, but with updated and improved content.

Redux Fundamentals Workshop

Redux co-maintainer Mark Erikson has put together a Redux Fundamentals workshop, and slides are available here. They cover:

• The history and purpose of Redux
• Reducers and actions, and working with a Redux store
• Using Redux with React
• Using and writing Redux middleware
• Working with AJAX calls and other side effects
• Unit testing Redux apps
• Real-world Redux app structure and development

Documentation

• Introduction
• Basics
• Advanced
• Recipes
• FAQ
• Troubleshooting
• Glossary
• API Reference

For PDF, ePub, and MOBI exports for offline reading, and instructions on how to create them, please see: paulkogel/redux-offline-docs.

For Offline docs, please see: devdocs

Examples

Almost all examples have a corresponding CodeSandbox sandbox. This is an interactive version of the code that you can play with online.

• Counter Vanilla: Source
• Counter: Source | Sandbox
• Todos: Source | Sandbox
• Todos with Undo: Source | Sandbox
• Todos w/ Flow: Source
• TodoMVC: Source | Sandbox
• Shopping Cart: Source | Sandbox
• Tree View: Source | Sandbox
• Async: Source | Sandbox
• Universal: Source
• Real World: Source | Sandbox

If you're new to the NPM ecosystem and have troubles getting a project up and running, or aren't sure where to paste the gist above, check out simplest-redux-example that uses Redux together with React and Browserify.

Testimonials

“Love what you're doing with Redux”
Jing Chen, creator of Flux

“I asked for comments on Redux in FB's internal JS discussion group, and it was universally praised. Really awesome work.”
Bill Fisher, author of Flux documentation

“It's cool that you are inventing a better Flux by not doing Flux at all.”
André Staltz, creator of Cycle

Thanks

• The Elm Architecture for a great intro to modeling state updates with reducers;
• Turning the database inside-out for blowing my mind;
• Developing ClojureScript with Figwheel for convincing me that re-evaluation should “just work”;
• Webpack for Hot Module Replacement;
• Flummox for teaching me to approach Flux without boilerplate or singletons;
• disto for a proof of concept of hot reloadable Stores;
• NuclearJS for proving this architecture can be performant;
• Om for popularizing the idea of a single state atom;
• Cycle for showing how often a function is the best tool;
• React for the pragmatic innovation.

Special thanks to Jamie Paton for handing over the redux NPM package name.

Logo

You can find the official logo on GitHub.

Change Log

This project adheres to Semantic Versioning.
Every release, along with the migration instructions, is documented on the GitHub Releases page.

Patrons

The work on Redux was funded by the community.
Meet some of the outstanding companies that made it possible:

• Webflow
• Ximedes

See the full list of Redux patrons, as well as the always-growing list of people and companies that use Redux.

License

MIT