Package detail

json-schema-defaults

chute65.3kMIT0.4.0

Generate JSON object from default values in JSON Schema

json, schema

readme

JSON Schema Defaults Build Status

Generate JSON object from default values in JSON Schema

Works both in node and browser.

Installation

  • npm

    npm install json-schema-defaults
    
  • bower

    bower install json-schema-defaults
    
  • manual

    Download lib/defaults.js

Usage

  • CommonJS (node.js)

    var defaults = require('json-schema-defaults');
    defaults({ ... });
    
  • RequireJS

    // in require.js config
    paths: {
      'defaults': './path/to/lib/defaults.js'
    }
    
    // in a file
    define(['defaults'], function(defaults) {
      defaults({ ... });
    });
    
  • standalone

    window.jsonSchemaDefaults({ ... });
    

    If the standalone version causes any conflict with existing jsonSchemaDefaults global variable, you can return back the original variable:

    var defaults = window.jsonSchemaDefaults.noConflict();
    // `window.jsonSchemaDefaults` now points to the original variable
    // `defaults` points to this script
    defaults({ ... });
    
  • CLI

    If installed globally:

    json-schema-defaults schema.json
    

    If locally:

    ./node_modules/.bin/json-schema-defaults schema.json
    

    Custom indentation (defaults to 2):

    json-schema-defaults --indent 4 schema.json
    

    Write into a file:

    json-schema-defaults schema.json > defaults.json
    

Documentation

Call defaults with JSON Schema. The default values will be extracted as a JSON.

var json = defaults({
  "title": "Album Options",
  "type": "object",
  "properties": {
    "sort": {
      "type": "string",
      "default": "id"
    },
    "per_page": {
      "default": 30,
      "type": "integer"
    }
  }
});

// would return
{
  sort: 'id',
  per_page: 30
}

For more examples, see the tests.

Development

Run tests

npm test

Or individually

# in node
./node_modules/.bin/jasmine-node test/

# in browser
./node_modules/karma/bin/karma start

Contributors

  • Eugene Tsypkin @jhony-chikens

License

(c) 2015 Chute Corporation. Released under the terms of the MIT License.

changelog

0.4.0 (2018-02-13)

  • Add CLI (by @mohd-akram) (fcb6a27)

0.3.0 (2016-12-26)

  • clone array items defined by object schema (31fd902a)

0.2.0 (2016-08-05)

0.1.1 (2015-03-17)

Bug Fixes

0.1.0 (2015-01-30)

  • $ref and allOf property support (by @jhony-chikens) (e2dd6c90)

0.0.2 (2014-05-04)

Bug Fixes

0.0.1 (2014-04-28)

Initial version.