ive
Isomorphic validation. Validate your forms in the browser and the form data on the server using the same schemas.
Installation
Server:
npm install ive
Browser (duo):
var Ive = ;
Browser (standalone):
Browser (browserify):
- accepting PRs
Features
- Node & browser support
- Generator-friendly
- Thoughtful form validation
- Data cleansing, formatting & casting
- Asynchronous & custom validation
- Validate against partial schemas
- Informative errors
- Composable schemas
Example
user-schema.js
var ive = moduleexports = ; ive typeString ; ive ive typeString ; ive ;
Browser
index.html
index.js
var schema = ;;// there is no next step! form looks for `[validate]` and// then validates the `input[name]` against Ive's schema
Server
Express
server.js
var schema = ; app;
Koa
server.js
var schema = ; app;
API
Ive([attrs])
Initialize an Ive
instance with an optional set of attrs
.
ive([str], obj, [fn])
Validate obj
against the schema, calling fn
when the validation is complete. fn
has the signature
function(error, val) { ... }
. val
is the new object that may be cleansed, formatted, and cast.
var ive = ; ;
If you're working with generators you can omit fn
and Ive will return a thunk:
var ive = ; var val = ;
You can also choose to validate against certain properties. This is useful if you're making updates to an existing document and you don't have all the properties:
var ive = ; // only validate on name and email;
ive.attr(name|ive|obj, [rube])
Add an attribute, ive instance, or object to ive
. Optionally you may pass a rube
instance as the key.
ive;
If you just specify a name, ive returns a rube instance.
ive
Ive schemas are composable:
var basic = ; basic typeString ; basic typeString ; var admin = ; admin typeString ;
Differences to other libraries
parsley.js
- Nice for simple form validation, but it's declarative nature tends to get verbose very quickly.
- No server-side support
- jQuery dependency
TODO
- Better support for different form elements (radio, checkbox, etc.)
- Customize the error formatting based on the environment
- Subclass the generic Error
Test
Server:
make test
Browser:
make browser
License
(The MIT License)
Copyright (c) 2014 Matthew Mueller <matt@lapwinglabs.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.