Socket
Socket
Sign inDemoInstall

json-struct

Package Overview
Dependencies
67
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    json-struct

Simple JSON schema validation


Version published
Weekly downloads
1
decreased by-83.33%
Maintainers
1
Install size
52.4 kB
Created
Weekly downloads
 

Readme

Source

Install

npm i json-struct --save

Example

const Schema = require('json-struct');

/* a json structure to test */
const testObject = {
  one: 'hello world',
  two: {
    three: {
      four: 4,
      five: [1, 3, 3]
    }
  }
};

/* custom schema that validates the json structure */
const exampleSchema = {

  one: {
    'value is one': v => {
      return v == 'hello world';
    }
  },

  two: {

    three: {

      four: {
        'should be a number': v => {
          return typeof v == 'number';
        },
        'should be greater than 0': v => {
          return v > 0;
        }

        /* more tests can go here */

      },

      five: {
        'has length three': v => {
          return v.length == 3;
        }
      }

    }
  }
}

const schema = new Schema(exampleSchema);
const result = schema.validate(test);

console.log(result);

Output

{
  "pass": true,
  "success": [
    "one value is one",
    "four should be a number",
    "four should be greater than 0",
    "five has length three"
  ],
  "errors": []
}

FAQs

Last updated on 23 Mar 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc