BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / json-schema-traverse / README.md

README.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
README.md 2.2 KiB Download Raw

json-schema-traverse

Traverse JSON Schema passing each schema object to callback

Build Status npm version Coverage Status

Install

npm install json-schema-traverse

Usage

const traverse = require('json-schema-traverse');
const schema = {
  properties: {
    foo: {type: 'string'},
    bar: {type: 'integer'}
  }
};

traverse(schema, cb);
// cb is called 3 times with:
// 1. root schema
// 2. {type: 'string'}
// 3. {type: 'integer'}

Callback function is called for each schema object (not including draft-06 boolean schemas), including the root schema. Schema references ($ref) are not resolved, they are passed as is.

Callback is passed these parameters:

  • _schema_: the current schema object
  • _JSON pointer_: from the root schema to the current schema object
  • _root schema_: the schema passed to traverse object
  • _parent JSON pointer_: from the root schema to the parent schema object (see below)
  • _parent keyword_: the keyword inside which this schema appears (e.g. properties, anyOf, etc.)
  • _parent schema_: not necessarily parent object/array; in the example above the parent schema for {type: 'string'} is the root schema
  • _index/property_: index or property name in the array/object containing multiple schemas; in the example above for {type: 'string'} the property name is 'foo'

Traverse objects in all unknown keywords

const traverse = require('json-schema-traverse');
const schema = {
  mySchema: {
    minimum: 1,
    maximum: 2
  }
};

traverse(schema, {allKeys: true}, cb);
// cb is called 2 times with:
// 1. root schema
// 2. mySchema

Without option allKeys: true callback will be called only with root schema.

License

MIT

Source
1# json-schema-traverse
2Traverse JSON Schema passing each schema object to callback
3
4[![Build Status](https://travis-ci.org/epoberezkin/json-schema-traverse.svg?branch=master)](https://travis-ci.org/epoberezkin/json-schema-traverse)
5[![npm version](https://badge.fury.io/js/json-schema-traverse.svg)](https://www.npmjs.com/package/json-schema-traverse)
6[![Coverage Status](https://coveralls.io/repos/github/epoberezkin/json-schema-traverse/badge.svg?branch=master)](https://coveralls.io/github/epoberezkin/json-schema-traverse?branch=master)
7
8
9## Install
10
11```
12npm install json-schema-traverse
13```
14
15
16## Usage
17
18```javascript
19const traverse = require('json-schema-traverse');
20const schema = {
21 properties: {
22 foo: {type: 'string'},
23 bar: {type: 'integer'}
24 }
25};
26
27traverse(schema, cb);
28// cb is called 3 times with:
29// 1. root schema
30// 2. {type: 'string'}
31// 3. {type: 'integer'}
32```
33
34Callback function is called for each schema object (not including draft-06 boolean schemas), including the root schema. Schema references ($ref) are not resolved, they are passed as is.
35
36Callback is passed these parameters:
37
38- _schema_: the current schema object
39- _JSON pointer_: from the root schema to the current schema object
40- _root schema_: the schema passed to `traverse` object
41- _parent JSON pointer_: from the root schema to the parent schema object (see below)
42- _parent keyword_: the keyword inside which this schema appears (e.g. `properties`, `anyOf`, etc.)
43- _parent schema_: not necessarily parent object/array; in the example above the parent schema for `{type: 'string'}` is the root schema
44- _index/property_: index or property name in the array/object containing multiple schemas; in the example above for `{type: 'string'}` the property name is `'foo'`
45
46
47## Traverse objects in all unknown keywords
48
49```javascript
50const traverse = require('json-schema-traverse');
51const schema = {
52 mySchema: {
53 minimum: 1,
54 maximum: 2
55 }
56};
57
58traverse(schema, {allKeys: true}, cb);
59// cb is called 2 times with:
60// 1. root schema
61// 2. mySchema
62```
63
64Without option `allKeys: true` callback will be called only with root schema.
65
66
67## License
68
69[MIT](https://github.com/epoberezkin/json-schema-traverse/blob/master/LICENSE)