schema-in-js's Introduction

schema-in-js

Write json schema fast in js.

In Developing! Every version may have breaking change!

Why?

JSON is tedious and error prone.
JSON schema is tedious and error prone.

Install

npm install schema-in-js

Usage

Suppose we want to write json schema for a entity called user which has username, password, age, gender, province and city. City can be provided only if province exsits.

If wrote in json schema, the result is:

{
    "type": "object",
    "description": "User",
    "properties": {
        "username": {
            "type": "string",
            "maxLength": 20,
            "minLength": 4
        },
        "password": {
            "type": "string",
            "pattern": "^(?:\\d+|[a-zA-Z]+|[!@#$%^&*]+)$"
        },
        "age": {
            "type": "integer",
            "max": 100,
            "min": 16
        },
        "gender": {
            "enum": ["male", "female"]
        },
        "province": {
            "type": "string",
            "maxLength": 10
        },
        "city": {
            "type": "string",
            "maxLength": 10
        }
    },
    "required": ["username", "password"],
    "dependencies": {
        "city": ["province"]
    }
}

With schema in js, the result is:

import {default as sj, description, dependencies} from 'schema-in-js';
export const userSchema = {
    [description]: 'User',
    username: sj.str.length(10, 4),
    password: sj.str.pattern('^(?:\\d+|[a-zA-Z]+|[!@#$%^&*]+)$'),
    age: sj.int.range(100, 16).mayBe(),
    gender: sj.enum('male', 'female').mayBe(),
    province: sj.str.length(10).mayBe(),
    city: sj.str.length(10).mayBe(),
    [dependencies]: {city: ['province']}
};