@vitalets/micro-schema

micro-schema

JavaScript implementation of JSON micro schema validation format.

Contents

• Installation
• Usage
• Docs
• License

Installation

npm install @vitalets/micro-schema

Usage

1. Require validate function:

   const { validate } = require('@vitalets/micro-schema');

2. Define schema:

   const schema = {
     productId: {
       $type: 'number',
       $required: true
     },
     productName: {
       $type: 'string',
       $required: true,
       $maxLength: 255
     },
     tags: [{
       $type: 'string'
     }]
   };

3. Validate object:

   const object = {
     productId: '1',
     productName: undefined,
     tags: [42]
   };
   
   const errors = validate(schema, object);

4. Handle validation errors:

   [
     {
       "validator": "$type",
       "path": "productId",
       "expectedType": "number",
       "actualType": "string"
     },
     {
       "validator": "$required",
       "path": "productName"
     },
     {
       "validator": "$type",
       "path": "tags.0",
       "expectedType": "string",
       "actualType": "number"
     }
   ]

Docs

Please see JSON micro schema docs for all available validators.

License

MIT @ Vitaliy Potapov