Needlessly Promiscuous, Modularize!

    with-redux-types

    1.0.0 • Public • Published

    Welcome to with-redux-types 👋

    Runtime type checker for redux with PropTypes

    A common use case is that you want to store payloads from the backend in your redux store, that is then consumed by other parts of the application. This can often be a scary thing because you cannot validate data in the central store is what you expect it to be since it's defined by the backend.

    PropTypes to the rescue. with-redux-types wraps usage of prop-types and allows you get runtime errors that allows you to highlight bugs or inconsistencies in your builds early. It also provides helpful feedback by pushing errors to the console if it happens in production that you can then push into alerting tools.

    Installation

    yarn add with-redux-types

    Usage

    Because this is a runtime validation, it's recommended you run this in production mode to get the most value, which you can do by importing prop-types/prop-types instead of prop-types.

    // types.js
    import PropTypes from 'prop-types/prop-types';
     
    export default {
      something: PropTypes.shape({
        stuff: PropTypes.oneOf([
          'this',
          'or',
          'that',
        ]),
      }).isRequired,
      else: PropTypes.arrayOf(PropTypes.shape({
        thingy: PropTypes.number.isRequired,
        that: PropTypes.string,
      })).isRequired,
    }
     
    // reducer.js
    import withReduxTypes from 'with-redux-types';
     
    import types from './types';
     
    export default withReduxTypes((state = initialState, action) => {
      switch (action.type) {
        default:
          return state;
      }
    }), types, 'racing')

    Output

    Sample error message

    Development

    Install

    yarn

    Run tests

    yarn test

    Show your support

    Give a ⭐️ if this project helped you!

    Install

    npm i with-redux-types

    DownloadsWeekly Downloads

    6

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    42.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • brianzchen