Datalize
此包修改自flowstudio/datalize,添加了多语言功能。
Parameter, query, form data validation and filtering for Koa and Express.
See also this post about it on the Toptal Engineering Blog.
Installation
npm install --save datalize
Usage
Koa
const Koa = ;const Router = ;const datalize = ;const field = datalizefield; const app = ; // add any body parserapp; const router = ; router; app;
Express
const express = ;const datalize = ;const field = datalizefield; const app = ; // add any body parserapp; app;
Methods
datalize(fields, options)
Creates Data object and returns validation middleware, which uses body
as source. Result is set to context/request.form
object.
datalize.params(fields, options)
Same as datalize()
, but uses params
as source. Result is set to context/request.data
object.
datalize.query(fields, options)
Same as datalize()
, but uses query
as source. Result is set to context/request.data
object.
datalize.field(name, label)
Returns: Field
Creates Field object.
datalize.set(name, value)
Sets global option for datalize.
datalize;
Options
type
Type: String
, Default: 'form'
breakOnRequired
Type: Boolean
, Default: true
If required error is returned, no other errors will be collected.
autoValidate
Type: Boolean
, Default: false
Auto validates form and throws Data.Error
if there is any error.
autoConvertToArray
Type: Boolean
, Default: false
Auto converts field.array()
fields to array.
error
Type: Error
, Default: DataError
Error object thrown on autoValidate.
Filters
All filters and chainable.
;
condition
: can throw errorfilter
: updates value
field.required()
condition
field.requiredIf(nameOrFn, requiredValue)
condition
- nameOrFn:
String|function
- requiredValue:
any
(optional) used only if nameOrFn is string
field.optional()
filter
- The field is removed if value is undefined.
field.optionalIf(nameOrFn, requiredValue)
filter
- nameOrFn:
String|function
- requiredValue:
any
(optional) used only if nameOrFn is string - The field is removed if value is undefined and conditions are passed.
field.patch()
filter
- The same as optional but only if request's method is PATCH.
field.array()
filter
- Returned value will be an Array.
field.container(children)
filter
- children:
Array
- Creates container will children fields, can be combined with
field.array()
.
field.split(separator = ',')
filter
- Converts value to array via splitting by separator.
field.custom(fn)
condition
,filter
field.bool(requiredValue)
condition
,filter
- requiredValue:
Boolean
(optional) - Converts to boolean and if
requiredValue
is provided, the field's value must be equal to it.
field.toggle(requiredValue)
condition
,filter
- requiredValue:
Number
(optional) - Converts to number (0, 1) and if
requiredValue
is provided, the field's value must be equal to it.
field.equal(compare)
condition
- compare:
any
field.default(defaultValue)
filter
- defaultValue:
any
field.nullable()
filter
- Converts to null if is empty.
field.email()
condition
field.number()
condition
,filter
field.uppercase()
filter
field.lowercase()
filter
field.trim()
filter
field.truncate(length)
filter
- length:
Number
field.range(min, max)
condition
,filter
- min:
Number|String|Function
(can be a number or name of a field or function that returns number) - max:
Number|String|Function
(can be a number or name of a field or function that returns number)
field.min(min)
condition
,filter
- min:
Number|String|Function
(can be a number or name of a field or function that returns number)
field.max(max)
condition
,filter
- max:
Number|String|Function
(can be a number or name of a field or function that returns number)
field.length(min, max)
condition
- min:
Number
- max:
Number
field.minLength(min)
condition
- min:
Number
field.maxLength(max)
condition
- max:
Number
field.int()
condition
,filter
field.float()
condition
,filter
field.id()
condition
,filter
field.select(options)
condition
- options:
Array
File filters
field.file()
filter
- Gets file from
req.files
object.
field.mime(types)
condition
- types:
Array
field.size(limit)
condition
- limit:
Number
in Bytes
Custom filter
field; field; field;
Using custom filter globally
const datalize = ;const field = datalizefield; datalizeFieldprototype { const regexp = `^([]+)$`; // make sure to return this.add() or this object to allow chaining return this;}; // then the filter can be used anywhere;
Error handling
router;
Global error handling
Koa
datalize; // add to very beginning of koa middlewaresapp;
Express
datalize; // add to very end of express middlewaresapp;
License
MIT
Copyright (c) 2018 Andrej Adamcik