JSON Schema Defaults

A library and CLI tool for generating a default value from a JSON schema

Installation

1npm install @nodecg/json-schema-defaults

Usage

• Node (TypeScript/ESM)

  1import defaults from 'json-schema-defaults';
  2defaults({ ... });

• 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.

1const 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

Contributors

• Eugene Tsypkin @jhony-chikens (original author of json-schema-defaults on npm)
• Alex Van Camp @alvancamp

License

(c) 2023 The NodeCG Project. Released under the terms of the MIT License.