mschema

A concise schema language for describing the structure of JSON data

Features

- simple intuitive syntax
- schemas are JSON
- schemas can be linked using require()

$3

- mschema-rpc(http://github.com/mschema/mschema-rpc)

$3

npm install mschema

$3

component install mschema/mschema

Example

see '/test' folder for alternate syntax and examples

``js

var mschema = require('mschema');

var user = {
"name": {
"type": "string",
"minLength": 5,
"maxLength": 20
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 64
},
"email": "string"
}

var data = {
"name": "Marak",
"password": "atleasteight",
"email": "foo@bar.com"
}

// validates true
var result = mschema.validate(data, user);
console.log(result);

var data = {
"name": "M",
"password": "1234",
"email": "foo@bar.com"
}

// validates false with errors
var result = mschema.validate(data, user);
console.log(result);

var blog = {
"name": "string",
"posts": [{"title": { "type": "string", "maxLength": 15 }, "author": "string", "content": "string" }]
};

var data = {
"name": "My blog",
"posts": [{
"title": "An example blog post",
"author": "Marak",
"content": "This is an example blog post"
}]
};

// validates true
var result = mschema.validate(data, blog);
console.log(result);
`

API

$3

$3

see: /examples and /test folders for additional usage

$3

`json
{
"name": "string",
"age": "number",
"address": "object",
"isActive": "boolean"
}
`

$3

`json
{
"id": {
"type": "string",
"minLength": 5,
"maxLength": 10
}
}
`

$3

`json
{
"name": "string",
"password": "string",
"address": {
"street": "string",
"city": "string",
"country": "string"
}
}
`

Typed arrays

$3

`json
{ "posts": ["string"] }
`

$3

`json
{ "posts": [{ "type": "string", "minLength": 5, "maxLength": 10 }] }
`

$3

`js
{ "posts": [{
"title": {
"type": "string",
"minLength": 3,
"maxLength": 15
},
"content": {
"type": "string",
"minLength": 3,
"maxLength": 15
}
}]
`

Linking Schemas

Schemas can be linked together using JS

`js

var address = {
"street": "string",
"city": "string",
"zipcode": "string"
}

var user = {
"name": "string",
"age": "number",
"address": address

var data = {
"name": "Marak",
"age": 42,
"address": {
"street": "123 elm street",
"city": "Canada",
"zipcode": "12345-01"
}
};

var validate = mschema.validate(data, user);

// validates to true

``

Relation to JSON-Schema

JSON-Schema was designed to the specifications of XML-Schema, which was designed to express Document Type Definitions.

Simply put: JSON-Schema has a lot of functionality that most developers don't need or want. The complexity of JSON-Schema makes it difficult to use and hard to build tools for.

$3

mschema has...

- Brevity of syntax
- Less features
- JavaScript Support