https://github.com/javierbyte/react-statevalidator

React state validation tool.
https://github.com/javierbyte/react-statevalidator

Last synced: 4 months ago
JSON representation

React state validation tool.

• Host: GitHub
• URL: https://github.com/javierbyte/react-statevalidator
• Owner: javierbyte
• Created: 2015-01-12T01:55:02.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-01-28T18:38:38.000Z (over 9 years ago)
• Last Synced: 2025-02-06T02:15:47.438Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# React State Validator.

React state validation tool.

# Installation.

    npm install react-statevalidator --save

# Usage.

    var stateValidatorMixin = require('react-statevalidator');

    /* ... */

    mixins: ['stateValidatorMixin'];

## Setting validation rules.

Add a `stateValidations` function to your component that returns an object with the desired validations.

Each property must be an object with a `value` that is the state that we will evaluate, and `validations` wich is an array with the validation strings (see available validations below).

    stateValidations: function() {

        return {

            positiveNumber: {

                value: this.state.positiveNumber,

                validations: [

                    'positiveNumber',

                    'required'

                ]

            },

            requiredThing: {

                value: this.state.something,

                validations: [

                    'required'

                ]

            },

            validEmail: {

                value: this.state.email

                validations: [

                    'email'

                ]

            }

        }

    },

## Validating.

Example: validating the `positiveNumber` rule we previously defined:

    this.validate('positiveNumber');

Will return and `object` with the validation results.

    // for this.state.positiveNumber = 'a'

    {

        all: false,

        number: false,

        required: true

    }

    // for this.state.positiveNumber = 3

    {

        all: true,

        number: true,

        required: true

    }

If we want to validate all our rules in `stateValidations`, simple run `this.validate` without parameters:

    this.validate();

Will return `true` if ALL our rules are valid ones, otherwise, `false`. Note that this method currently don't return an object.

# Available validation rules.

* `email`: The value is an email.

* `number`: The value is strictly a number.

* `positiveNumber`: The value evaluates to a positive number.

* `required`: The value is there.

* `all`: All the rules in the object are valid. This rule is created automatically.

# Roadmap.

* More validations and allow custom function validations.

* Return a more detailed object with validating all.

* Add some tests.