Skip to content

Listener Cancellation

In this lesson you will learn listener cancellation in Redux, why it matters within listener middleware, and how to use it correctly with clear, copy-ready examples.

Listener Cancellation Overview

Listener Cancellation is something you will reach for often in Redux. It keeps your workflow predictable and makes your intent obvious to reviewers and teammates.

When you learn listener cancellation properly, you avoid the guesswork that leads to mistakes and rework. The example below shows the shape you will use in most real Redux projects.

import { createListenerMiddleware } from '@reduxjs/toolkit';
import { increment } from './counterSlice';

export const listener = createListenerMiddleware();

listener.startListening({
  actionCreator: increment,
  effect: async (action, api) => {
    console.log('incremented', api.getState());
  },
});

Listener middleware reacts to dispatched actions to run side effects, replacing many custom thunks.

Listener Cancellation Example

const slice = createSlice({ name, initialState, reducers });
const store = configureStore({ reducer: { key: slice.reducer } });
// dispatch(slice.actions.something())
  • Start from a minimal Listener Cancellation example and grow it only as needed.
  • Keep things explicit so Listener Cancellation behaves the same for everyone on the team.
  • Name things clearly so teammates understand your Listener Cancellation at a glance.
  • Verify Listener Cancellation works as expected before relying on it in important work.

Redux Cheatsheet

Quick Redux Toolkit reference related to listener cancellation.

Concept Example Purpose
Store configureStore({ reducer }) Hold app state
Slice createSlice({ name, reducers }) State + actions together
Read state useSelector((s) => s.x) Get data in components
Dispatch useDispatch() Send actions
Async createAsyncThunk(...) Handle side effects
Data fetching createApi(...) RTK Query endpoints
Derived data createSelector(...) Memoized computations

How Listener Cancellation Works in Redux

Listener Cancellation follows Redux's predictable data flow: components dispatch actions, reducers compute the next state from the previous state and the action, and subscribed components re-render.

Listener middleware reacts to dispatched actions to run side effects, replacing many custom thunks.

  • State lives in a single, read-only store.
  • Actions are the only way to describe a change.
  • Reducers are pure functions that return the next state.
  • Redux Toolkit removes most boilerplate with slices and thunks.

Practical Guidance for Listener Cancellation

In modern apps, listener cancellation should use Redux Toolkit rather than hand-written Redux. Keep state minimal, colocate logic in slices, and use RTK Query for server data.

Concern Recommendation
Boilerplate Use Redux Toolkit (createSlice)
Server data Prefer RTK Query over manual thunks
Performance Memoize selectors with createSelector
Types Use typed useAppSelector/useAppDispatch hooks

Common Mistakes

  • Copying listener cancellation commands or snippets without understanding what each part does.
  • Skipping edge cases and error handling when using listener cancellation.
  • Not verifying the result of listener cancellation before moving on.
  • Over-complicating listener cancellation before you actually need the extra flexibility.

Key Takeaways

  • Listener Cancellation is a core part of working effectively with Redux.
  • Start small and keep listener cancellation focused on a single goal.
  • Apply consistent patterns so listener cancellation scales across your project.
  • Practise and document listener cancellation to keep your workflow maintainable.

Pro Tip

Practise listener cancellation on a throwaway project first. It is far cheaper to learn Redux mistakes there than on important work.