node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

archetype-actions

archetype-actions

Create Redux actions with run time type checks via Archetype

NPM

Build status semantic-release js-standard-style

Goal

Add simple run time checks to the actions created in Redux by using Archetype

Action creators are usually simple functions, yet this is a good moment to do the runtime type checks to avoid polluting the store with inconsistent state.

// typical "add Todo" action 
const addTodo = (text) => {
  return {
    type: 'ADD_TODO',
    text
  }
}

How

This is a very simple wrapper around Archetype code that just hides some details. See src/archetype-actions-spec.js for the current examples.

const archetypeAction = require('archetype-actions')
const addTodo = archetypeAction('ADD_TODO', {
  text: {
    $type: 'string',
    $required: true
  }
})
const add = addTodo({text: 'do something'})

The created objects can be nicely serialized

console.log(add)
// ADD_TODO { text: 'do something', type: 'ADD_TODO' } 
console.log(JSON.stringify(add, null, 2))
/*
{
  "text": "do something",
  "type": "ADD_TODO"
}
*/

A missing property causes a validation error

const add = addTodo({what: 'do something'})
// Error: text: Path "text" is required 
// at ADD_TODO (index.js:17:16) 

Additional fields

You might want create helper wrapper if an action requires additional information. For example, if you want to include an id with each item

// typical Redux 
let nextTodoId = 0
const addTodo = (text) => {
  return {
    type: 'ADD_TODO',
    id: nextTodoId++,
    text
  }
}
// archetype-actions 
const archetypeAction = require('archetype-actions')
const addTodo = archetypeAction('ADD_TODO', {
  id: {
    $type: 'number', // check both id 
    $required: true
  },
  text: {
    $type: 'string', // and the text 
    $required: true
  }
})
let nextTodoId = 0
// helper function 
const AddTodo = (text) => addTodo({id: nextTodoId++, text})
const add = AddTodo('do something')

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2016

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2016 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.