https://github.com/js-data/js-data-schema
Define and validate rules, datatypes and schemata in Node and in the browser.
https://github.com/js-data/js-data-schema
Last synced: 2 months ago
JSON representation
Define and validate rules, datatypes and schemata in Node and in the browser.
- Host: GitHub
- URL: https://github.com/js-data/js-data-schema
- Owner: js-data
- License: mit
- Created: 2014-09-15T19:47:13.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-06-03T17:22:51.000Z (about 10 years ago)
- Last Synced: 2025-04-07T17:54:10.542Z (3 months ago)
- Language: JavaScript
- Homepage: http://www.js-data.io/docs/js-data-schema
- Size: 718 KB
- Stars: 18
- Watchers: 2
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## js-data-schema [](https://www.npmjs.org/package/js-data-schema) [](https://www.npmjs.org/package/js-data-schema) [](https://circleci.com/gh/js-data/js-data-schema/tree/master) [](https://www.npmjs.org/package/js-data-schema) [](https://github.com/js-data/js-data-schema/blob/master/LICENSE)
__Define and validate rules, datatypes and schemata in Node and in the browser.__
### API Documentation
[Schemator API](http://www.js-data.io/docs/js-data-schema)
### Install
##### Node
`npm install --save js-data-schema`
```js
var Schemator = require('js-data-schema');
```
##### Browser
`npm install --save js-data-schema` or `bower install --save js-data-schema`
Load `js-data-schema/dist/js-data-schema.js` into your browser.
```js
// global constructor if you're not using AMD or CommonJS
window.Schemator;
// AMD
define(['js-data-schema'], function (Schemator) { ... })
// CommonJS
var Schemator = require('js-data-schema');
```
### Getting Started
```js
var schemator = new Schemator();
schemator.defineSchema('Person', {
name: 'string'
});
var errors = schemator.validateSync('Person', { name: 'John' });
errors; // null
errors = schemator.validateSync('Person', { name: 50043 });
errors; // {
// name: [{
// rule: 'type',
// actual: 'number',
// expected: 'string'
// }]
// }
```
### Project Status
__Latest Release:__ [](https://github.com/js-data/js-data-schema/releases)
__Status:__
[](https://gemnasium.com/js-data/js-data-schema) [](https://coveralls.io/r/js-data/js-data-schema?branch=master) [](https://www.codacy.com/public/jasondobry/js-data-schema/dashboard)
__Supported Platforms:__
[](https://github.com/js-data/js-data)
### API
[js-data-schema api](http://www.js-data.io/docs/js-data-schema)
### Contributing
First, support is handled via the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
- good - Your versions of js-data, js-data-schema, etc, relevant console logs/error, code examples that revealed the issue
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
[Github Issues](https://github.com/js-data/js-data-schema/issues).
#### Pull Requests
1. Contribute to the issue that is the reason you'll be developing in the first place
1. Fork js-data-schema
1. `git clone https://github.com//js-data-schema.git`
1. `cd js-data-schema; npm install; bower install;`
1. `grunt go` (builds and starts a watch)
1. (in another terminal) `grunt karma:dev` (runs the tests)
1. Write your code, including relevant documentation and tests
1. Submit a PR and we'll review
### License
[MIT License](https://github.com/js-data/js-data-schema/blob/master/LICENSE)
Copyright © 2013-2015 Jason Dobry
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.