Magical, Flexible and Extendible Javascript Validation.
npm:
npm i validazz
Yarn:
yarn add validazz
import Validator, { rules } from 'validazz'
const mySuperCoolValidator = Validator.factory()
// Let's add some rules
mySuperCoolValidator.addRule(rules.isRequired)
mySuperCoolValidator.addRules([rules.minLength(2), rules.maxLength(8)])
mySuperCoolValidator.addRule(rules.isString)
// How about a custom rule?
const customRule = {
runWithValue: value => {
if (value !== '🤪') return false
return true
},
message: 'Houston, we got a problem',
}
mySuperCoolValidator.addRule(customRule)
// Okay let's start validating
const { success, failed } = mySuperCoolValidator.runWithValue('hello')
if (success) {
console.log('Wow, this was validated just like that')
} else {
const { message } = failed
console.log(`Okay so here's the error message: ${failed}`)
}
For a list of all the included rules, be sure to check the RULES.md file
Magical, Flexible and Extendible Javascript Validation.
npm:
npm i validazz
Yarn:
yarn add validazz
import Validator, { rules } from 'validazz'
const mySuperCoolValidator = Validator.factory()
// Let's add some rules
mySuperCoolValidator.addRule(rules.isRequired)
mySuperCoolValidator.addRules([rules.minLength(2), rules.maxLength(8)])
mySuperCoolValidator.addRule(rules.isString)
// How about a custom rule?
const customRule = {
runWithValue: value => {
if (value !== '🤪') return false
return true
},
message: 'Houston, we got a problem',
}
mySuperCoolValidator.addRule(customRule)
// Okay let's start validating
const { success, failed } = mySuperCoolValidator.runWithValue('hello')
if (success) {
console.log('Wow, this was validated just like that')
} else {
const { message } = failed
console.log(`Okay so here's the error message: ${failed}`)
}
For a list of all the included rules, be sure to check the RULES.md file
Validation Factory, where all the validation magic happens
Type: Validator
rules
Array<ValidationRule> List of rules to initalize with (optional, default[]
)
Add a rule to the factory
rule
ValidationRule A validation rule
Returns Validator Validator instance
Add a rules to the factory
rules
Array<ValidationRule> An array of rules to add
Returns Validator Validator instance
- See: validate
Run the factory and validate!
value
string The string to be validated
Returns ValidatorResult The validation outcome
Meta
- deprecated: Use
validate(value: string)
instead. Depricated since v1.1
Validates a string
value
String The string to be validated
const { success, failed } = Validator.factory(rules.isRequired).validate(
'hello'
)
Returns ValidatorResult The validation outcome
Create a new validation factory
rules
Array<ValidationRule> List of rules to initalize the factory with (optional, default[]
)
const validator = Validator.factory([])
Returns Validator Validator instance
The validation function for this rule. It takes the a string/integer value and returns a boolean.
Type: Function
value
string Value of array element
const rule = {
runWithValue(value) {
return value != null
},
}
Returns Boolean If it returns true, the field is valid.
A validation rule
Type: Object
message
string A custom error message for this validation rulerunWithValue
runWithValue Validation callback
// Basic Example
const validationRule = {
message: 'This field is required',
runWithValue(value) {
return value != null
},
}
// Example with parameters
const minimum = min => ({
message: `Amount must be greater than ${min}`,
runWithValue(value) {
const value = Number(value)
return value > min
},
})
The validation result
Type: Object
success
Boolean The outcome of the validationfailed
ValidationRule An optional value. Returns the rule that failed to validate
const { success, failed } = Validator.factory(rules.isRequired).validate(
'hello'
)
if (success) {
alert('validated')
} else {
const { message } = failed
alert(`Failed: ${message}`)
}
MIT © Jesse Onolememen
MIT © Jesse Onolememen