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

@lukalabs/json-schema-default-instance

v1.4.0

Published

Creates an object as an instance of the given schema using its default properties.

Downloads

24

Readme

json-schema-default-instance

Build Status

Creates an object as an instance of the given schema using its default properties.

  • Accepts multiple schemas, referenced by id.
  • Resolves $ref and allOf.
  • Instantiates all properties that have a default.
  • If requiredOnly = true, ignores properties that are not listed in the required array (see example below).
  • If resolveDefaultRefs = true, also resolves references within defaults.

Usage

Install with npm install --save json-schema-default-instance

See test/test.js for an example with $ref and allOf.

Simple example below:

const {Instantiator} = require('json-schema-default-instance');
const mySchemas = [
  {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "id": "theSchemaId",
    "type": "object",
    "required": [
      "firstName",
      "lastName"
    ],
    "properties": {
      "firstName": {
        "type": "string",
        "default": "Foo"
      },
      "lastName": {
        "type": "string",
        "default": "Bar"
      },
      "optionalProperty": {
        "type": "string",
        "default": "Hello"
      }
    }
  }
]

/* Instantiate with all properties */
let ins = new Instantiator(mySchemas);
let myDefaultInstance = ins.instantiate('theSchemaId');
console.log(myDefaultInstance);

// => { firstName: 'Foo', lastName: 'Bar', optionalProperty: 'Hello' }

/* This time, only with `required` properties */
ins.requiredOnly = true;
let myRequiredInstance = ins.instantiate('theSchemaId');
console.log(myRequiredInstance);

// => { firstName: 'Foo', lastName: 'Bar' }

Notes

Relies heavily on Ajv for caching and lookup by ref, even though no validation is done here. Ajv: Another JSON Schema Validator

Ajv does have its own useDefaults option which can be used instead of this package, but it does not support default keywords in subschemas or allOf. If you don't need allOf, just use Ajv directly (see Ajv assigning-defaults and related discussion).

Performance: this code recursively walks through the schema on each call, which can negatively impact performance. Depending on the use case, it may make sense to precompute the defaults and cache them to an object or module.

Need help understanding JSON Schema? I would recommend the Space Telescope Science Institute's Understanding JSON Schema

License

Public Domain