redux-ts-helpers v3.2.0

redux-ts-helpers

TypeScript helpers for idiomatic Redux.

Action Constants

applyNamespace takes a namespace and an object of action constants. You get back an object with the same keys, but they are strings like users/filter, users/update, users/delete.

export const constants = applyNamespace('users', {
  filter: 0,
  update: 0,
  delete: 0,
})

export const FILTER = 'USERS_FILTER'
export const UPDATE = 'USERS_UPDATE'
export const DELETE = 'USERS_DELETE'

Actions

createAction has multiple signatures:

1. const action = createAction('action')

   An action creator without a payload.

2. const action = createAction<number>('action')

   An action creator with a payload of type number.

3. const action = createAction('action', (arg1: string, arg2: number) => {
     /*...*/
   })

   An action creator with a complex payload. Arguments for the action are read from the given payload function.

export const increment = createAction(constants.increment)
export const setIncrementBy = createAction<number>(constants.setIncrementBy)
export const safeSetIncrementBy = createAction(
  constants.setIncrementBy,
  (n: number) => (n > 10 ? 10 : n),
)

export interface Increment {
  type: 'INCREMENT'
}
export const increment: ActionCreator<Increment> = () => ({
  type: 'INCREMENT',
})

export interface SetIncrementBy {
  type: 'SET_INCREMENT_BY'
  payload: number
}
export const setIncrementBy: ActionCreator<SetIncrementBy> = (n: number) => ({
  type: 'SET_INCREMENT_BY',
  payload: n,
})

export interface SafeSetIncrementBy {
  type: 'SET_INCREMENT_BY'
  payload: number
}
export const safeSetIncrementBy: ActionCreator<SafeSetIncrementBy> = (
  n: number,
) => ({
  type: 'SET_INCREMENT_BY',
  payload: n > 10 ? 10 : n,
})

Reducers

createReducer builds a reducer for you. No more switch statements, you pass it an object.

Use ReturnType<T> to get the type of a function's return value without having to know the interface beforehand.

import * as actions from './actions'

const initialState = {
  currentNumber: 0,
  incrementBy: 1,
}

export default createReducer(initialState, {
  [actions.constants.increment]: (state, action) => ({
    ...state,
    currentNumber: state.currentNumber + state.incrementBy,
  }),

  [actions.constants.setIncrementBy]: (
    state,
    action: ReturnType<typeof actions.setIncrementBy>,
  ) => ({
    ...state,
    incrementBy: actionTyped.payload,
  }),
})

import * as actions from './actions'

interface State {
  currentNumber: number
  incrementBy: number
}

const initialState: State {
  currentNumber: 0,
  incrementBy: 0,
}

export const reducer: Reducer<State> = (state = initialState, action) => {
  switch (action.type) {
    case actions.INCREMENT:
      return {
        ...state,
        currentNumber: state.currentNumber + state.incrementBy,
      }

    case actions.SET_INCREMENT_BY: {
      const actionTyped = action as actions.SetIncrementBy

      return {
        ...state,
        incrementBy: actionTyped.payload
      }
    }

    default:
      return state
  }
}

Action meta

You can use wrapWithMeta to generate an action creator that populates the meta property.

const deleteAccount = wrapWithMeta(
  createAction(constants.deleteAccount),
  () => ({
    analytics: {
      trackEvent: true,
    },
  }),
)

// deleteAccount()
// {
//   type: 'deleteAccount',
//   payload: undefined,
//   meta: {
//     analytics: {
//       trackEvent: true,
//     }
//   }
// }

const removeUser = wrapWithMeta(
  createAction<number>(constants.removeUser),
  (payload) => ({
    analytics: {
      trackEvent: true,
      id: payload,
    },
  }),
)

// removeUser(1234)
// {
//   type: 'removeUser',
//   payload: 1234,
//   meta: {
//     analytics: {
//       trackEvent: true,
//       id: 1234,
//     }
//   }
// }