JSON Schema Defaults

Generate JSON object from default values in JSON Schema

Works both in node and browser.

Installation

• npm

  1npm install json-schema-defaults

• bower

  1bower install json-schema-defaults

• manual

  Download lib/defaults.js

Usage

• CommonJS (node.js)

  1var defaults = require('json-schema-defaults');
  2defaults({ ... });

• RequireJS

  1// in require.js config
  2paths: {
  3  'defaults': './path/to/lib/defaults.js'
  4}
  5
  6// in a file
  7define(['defaults'], function(defaults) {
  8  defaults({ ... });
  9});

• standalone

  1window.jsonSchemaDefaults({ ... });

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

  1var defaults = window.jsonSchemaDefaults.noConflict();
  2// `window.jsonSchemaDefaults` now points to the original variable
  3// `defaults` points to this script
  4defaults({ ... });

• CLI

  If installed globally:

  1json-schema-defaults schema.json

  If locally:

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

  Custom indentation (defaults to 2):

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

  Write into a file:

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

Documentation

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

1var json = defaults({
2  "title": "Album Options",
3  "type": "object",
4  "properties": {
5    "sort": {
6      "type": "string",
7      "default": "id"
8    },
9    "per_page": {
10      "default": 30,
11      "type": "integer"
12    }
13  }
14});
15
16// would return
17{
18  sort: 'id',
19  per_page: 30
20}

For more examples, see the tests.

Development

Run tests

1npm test

Or individually

1# in node
2./node_modules/.bin/jasmine-node test/
3
4# in browser
5./node_modules/karma/bin/karma start

Contributors

• Eugene Tsypkin @jhony-chikens

License

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