Using Redux with Typescript for superior type safety
The benefits of Typescript in a team environment for building and maintaining production-worthy codebases are nothing new. At Cleo we committed early to developing our web and mobile apps with Typescript to give us the safety of static typing when developing our product.
One issue we faced building SPAs with Typescript was additional boilerplate when combined with other paradigms, specifically state management and Redux. The Redux docs[1] give a good starting point for Typescript integration, but their approach remains convoluted. We wanted a way of simplifying this integration to minimise the effort of achieving full type coverage within our codebase.
Our issue
Using Redux to manage state, but typescript can lead to additional boilerplate so type safety less likely to be used
Typescript shines when used everywhere in the codebase
Various state refactors and migrations (e.g. redux-thunk → redux-sagas) only benefit from typescript coverage when the underlying state is fully typed
Solution by example
We'll create a simple app for displaying a customer's transactions to show how we can create type safety alongside Redux.
State
We define a new type for our transaction, and the store's state.
We use a switch statement on the action's type, and the getType helper to extract the action's type. This allows the payload's type to be correctly inferred & used within the scope.
// reducer.ts
import * as transactionListActions from './actions'; import { ActionType, getType } from 'typesafe-actions'; import { Category, Transaction } from "../types";
export const transactionListReducer = (state: TransactionListState, action: ActionType<typeof transactionListActions>): TransactionListState => { switch (action.type) { case getType(transactionListActions.setTransactionCategory): //getType evaluates to 'SET_TRANSACTION_DESCRIPTION' // Payload is now typed correctly const { transactionId, categoryId } = action.payload; ... case getType(transactionListActions.deleteTransaction): // Payload is now typed correctly const transactionId = action.payload; ...
default: return state; } };
The following shows the payload type suggestions we get when within a case.
Selectors
Simply type the state
// selectors.ts
import { TransactionListState } from "./reducer"; import { Transaction } from "../types";
I joined Cleo in March as a Backend Ruby Engineer, three weeks after I joined the UK went into lockdown and I was working in a fully remote team. These four approaches to working have helped me stay an active contributor to the team over the last three months of isolation.
Look, it’s a psychologically weird time right now. I haven’t spoken to a new human in three weeks, I’ve downloaded TikTok, and I’m still not drinking enough water.