Walli
A manageable and immutable validation library.
Installation
npm install walli --save
Usage
ok
import { string, arrayOf } from 'walli'
string.ok('1') === true
string.ok(1) === false
arrayOf(string).ok(['a']) === true
arrayOf(string).ok(['a', 1]) === false
toUnlawfulString
string.toUnlawfulString('1') === ''
string.toUnlawfulString(1) === 'expected type: string, actual type: number.'
stringMatching('any').toUnlawfulString('axaxnyx', { delimiter: '\n' }) ===
"expected: stringMatching(/any/), actual: 'axaxnyx'."
check
string.check('1').ok === true
string.check('1').toString({ delimiter: '\n' }) ===
'expected type: string, actual type: number.'
message
// :actual: and :expected: are special placeholders.
string.message('error! :expected: :actual:').toUnlawfulString(1) ===
'error! string number'
const foo = eq({
name: string.message('name error!'),
age: number
}).message('error happened')
foo.toUnlawfulString({
name: '',
age: 'er'
}) === 'age: error happened'
foo.toUnlawfulString({
name: 222,
age: 19
}) === 'name: name error!'
Custom Type
- Expected Struction
// typescript
type Person = {
name: string
age: string
gender: 'F' | 'M'
father?: Person
mother?: Person
children?: Person[]
}
- Walli Type's Definition
import { string, eq, oneOf, arrayOf, array, integer, Verifiable } from 'walli'
import { util } from 'walli'
const { funcify, createVerifiableClass, createFinalVerifiable } = util
const person = createVerifiableClass({
getDisplayName() {
return 'person'
},
_check(req) {
return eq({
name: string,
age: integer,
gender: oneOf(['F', 'M']),
father: person().optional,
mother: person().optional,
children: arrayOf(person()).optional
}).check(req)
}
})
person().ok({
name: 'cy',
age: 22,
gender: 'F'
}) === true
person().toUnlawfulString({
// ...
})
// creates final verifiable instance like string / null_
const fperson = createFinalVerifiable(person)
fperson.ok({
// ...
})
// Or using es6 syntax
class Person extends Verifiable {
static displayName = 'person'
_check(req) {
// same code here
}
}
const es6Person = funcify(Person)
And the document named How to write a customized type would give you more help.
Related
- json-schema-walli - Transform json schema to walli definition.
Exported API
Verifiable List
function_
null_
undefined_
primitive
object
array
any
nil
- null or undefined
string
number
strictNumber
integer
any
objectOf(...)
objectOf()
objectOf(value)
objectOf([value, key])
arrayOf(value)
be(value)
oneOf([a, b, c])
equal(value)
- Alias
eq
looseEqual(value)
- Alias
leq