npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

validate-by-example

v1.5.0

Published

Derives a JSON schema from an object and then uses it to validate other objects

Downloads

131

Readme

validate-by-example

Derives a JSON schema from an object and then uses it to validate other objects

NPM

Build status semantic-release js-standard-style

Goal

Derive json schema from one object and use it to verify every object after that. Uses generate-schema and is-my-json-valid.

How to use

Install with npm install --save validate-by-example

In your code first train on an object (gives you a schema) and then validate an object.

const {train, validate} = require('validate-by-example')
const aPerson = {
  name: 'gleb',
  age: 37,
  married: true,
  lives: {
    city: 'Boston'
  }
}
const schema = train(person)
// now use schema to validate
const someone = {
  name: 'stranger',
  age: 'twenty',
  additional: 'some new property',
  lives: {
    state: 'MA'
  }
}
const result = validate(schema, someone)
// result is an object
// if everything goes well result.valid will be true
// otherwise
if (!result.valid) {
  console.log(result.errors)
}

The above example prints a few errors, because every property is required, and no additional properties is allowed.

[
  {
    "field": "data",
    "message": "has additional properties"
  },
  {
    "field": "data.age",
    "message": "is the wrong type"
  },
  {
    "field": "data.married",
    "message": "is required"
  },
  {
    "field": "data.lives",
    "message": "has additional properties"
  },
  {
    "field": "data.lives.city",
    "message": "is required"
  }
]

For error format, see is-my-json-valid

See more in tests

Inferring formats

For the top level properties, the train function tries to infer specific JSON schema v4 format. For example

const {train} = require('validate-by-example')
const schema = train({created: '2017-02-16T15:30:28.370Z'})
/*
  {
    '$schema': 'http://json-schema.org/draft-04/schema#',
    type: 'object',
    properties: {
      created: {
        type: 'string', required: true, format: 'date-time'
      }
    },
    additionalProperties: false
  }
*/

Note only hex RGB strings like #ff0ff or #FF00FF are inferred as color format.

Overriding formats

You can specify JSON schema v4 format for each property.

const {train, validate} = require('validate-by-example')
const user = {
  email: '[email protected]'
}
const schema = train(user, {email: 'email'})
/*
  schema.properties.email will be
  {type: 'string', required: true, format: 'email'}
*/
validate({email: 'unknown'})

This is equivalent to

const user = {
  email: '[email protected]'
}
const schema = train(user)
schema.properties.email.format = 'email'
validate(schema, {email: 'unknown'})

and will produce the following error

{
  "valid": false,
  "errors": [
    {
      "field": "data.email",
      "message": "must be email format"
    }
  ]
}

JSON schema

Related projects that can derive JSON schema from an object

Small print

Author: Gleb Bahmutov <[email protected]> © 2017

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov <[email protected]>

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.