/redux-validate-fsa

Redux middleware that validates if an action is a Flux Standard Action (FSA).

Primary LanguageJavaScriptMIT LicenseMIT

redux-validate-fsa

NPM

Build Status

Redux middleware that validates if an action is a Flux Standard Action (FSA).

Usage

const middleware = [reduxThunk]

// Only use in DEV mode
if (__DEV__) {
  const fsaMiddleware = require('redux-validate-fsa')(ignore /* optional */)
  middleware.push(fsaMiddleware)
}

The ignore argument specify actions that should be skipped from the FSA check. This is useful when dealing with non-compliant actions from third-party libraries.

  • If an array is given, it is the action types that should be skipped from the FSA check.
  • If a function is given, it must return true for actions that should be skipped from the FSA check.

For example, if you use react-router-redux, you should ignore its update-path actions, which are not FSA compliant.

import {LOCATION_CHANGE} from 'react-router-redux'
const fsaMiddleware = require('redux-validate-fsa')([LOCATION_CHANGE])

Notes:

  • This middleware is only useful in dev mode. Therefore, it should be conditionally imported.
  • If you use redux-thunk, make sure the thunk middleware is added before this middleware. Alternatively, you can use the ignore predicate to filter out actions that are thunks.

Test

npm install
npm test