Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jfairbank/revalidate
Elegant and composable validations
https://github.com/jfairbank/revalidate
composition functional javascript javascript-validation redux-form validation
Last synced: 8 days ago
JSON representation
Elegant and composable validations
- Host: GitHub
- URL: https://github.com/jfairbank/revalidate
- Owner: jfairbank
- License: mit
- Created: 2016-02-26T00:49:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-08T18:54:24.000Z (almost 6 years ago)
- Last Synced: 2024-07-02T21:58:20.347Z (5 months ago)
- Topics: composition, functional, javascript, javascript-validation, redux-form, validation
- Language: JavaScript
- Homepage: http://revalidate.jeremyfairbank.com
- Size: 4.99 MB
- Stars: 363
- Watchers: 7
- Forks: 20
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://www.npmjs.com/package/revalidate)
[](https://travis-ci.org/jfairbank/revalidate)
[](https://codecov.io/gh/jfairbank/revalidate)
#### Elegant and composable validations.
Revalidate is a library for creating and composing together small validation
functions to create complex, robust validations. There is no need for awkward
configuration rules to define validations. Just use functions.
All right. No more upselling. Just look at an example :heart:.
```js
// ES2015
import {
createValidator,
composeValidators,
combineValidators,
isRequired,
isAlphabetic,
isNumeric
} from 'revalidate';
// Or ES5
var r = require('revalidate');
var createValidator = r.createValidator;
var composeValidators = r.composeValidators;
var combineValidators = r.combineValidators;
var isRequired = r.isRequired;
var isAlphabetic = r.isAlphabetic;
var isNumeric = r.isNumeric;
// Usage
const dogValidator = combineValidators({
name: composeValidators(
isRequired,
isAlphabetic
)('Name'),
age: isNumeric('Age')
});
dogValidator({}); // { name: 'Name is required' }
dogValidator({ name: '123', age: 'abc' });
// { name: 'Name must be alphabetic', age: 'Age must be numeric' }
dogValidator({ name: 'Tucker', age: '10' }); // {}
```
## Install
Install with yarn or npm.
```
yarn add revalidate
```
```
npm install --save revalidate
```
## Getting Started
#### [Docs](http://revalidate.jeremyfairbank.com)
Revalidate has a host of options along with helper functions for building
validations and some common validation functions right out of the box. To learn
more, check out the docs at [revalidate.jeremyfairbank.com](http://revalidate.jeremyfairbank.com).
## Redux Form
Just one more example! You might have heard about revalidate through Redux Form.
Revalidate was originally conceived as a library for writing validation
functions for Redux Form. Revalidate is still a great companion to Redux Form!
Here is the simple synchronous form validation from Redux Form's
[docs](http://redux-form.com/6.1.1/examples/syncValidation) rewritten to use
revalidate:
```js
import React from 'react'
import { Field, reduxForm } from 'redux-form'
import {
createValidator,
composeValidators,
combineValidators,
isRequired,
hasLengthLessThan,
isNumeric
} from 'revalidate'
const isValidEmail = createValidator(
message => value => {
if (value && !/^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i.test(value)) {
return message
}
},
'Invalid email address'
)
const isGreaterThan = (n) => createValidator(
message => value => {
if (value && Number(value) <= n) {
return message
}
},
field => `${field} must be greater than ${n}`
)
const customIsRequired = isRequired({ message: 'Required' })
const validate = combineValidators({
username: composeValidators(
customIsRequired,
hasLengthLessThan(16)({
message: 'Must be 15 characters or less'
})
)(),
email: composeValidators(
customIsRequired,
isValidEmail
)(),
age: composeValidators(
customIsRequired,
isNumeric({
message: 'Must be a number'
}),
isGreaterThan(17)({
message: 'Sorry, you must be at least 18 years old'
})
)()
})
const warn = values => {
const warnings = {}
if (values.age < 19) {
warnings.age = 'Hmm, you seem a bit young...'
}
return warnings
}
const renderField = ({ input, label, type, meta: { touched, error, warning } }) => (
{label}
{touched && ((error && {error}) || (warning && {warning}))}
)
const SyncValidationForm = (props) => {
const { handleSubmit, pristine, reset, submitting } = props
return (
Submit
Clear Values
)
}
export default reduxForm({
form: 'syncValidation', // a unique identifier for this form
validate, // <--- validation function given to redux-form
warn // <--- warning function given to redux-form
})(SyncValidationForm)
```