npmpackage.info

Gathering detailed insights and metrics for json-schema-traverse

Other packages similar to json-schema-traverse

@json-schema-tools/traverse

1.10.4

This package exports a method that will traverse a JSON-Schema, calling a mutation function for each sub schema found. It is useful for building tools to work with JSON Schemas.

@babel/traverse

7.25.9

The Babel Traverse module maintains the overall tree state, and is responsible for replacing, removing, and adding nodes

json-schema

0.4.0

JSON Schema validation and specifications

@types/json-schema

7.0.15

TypeScript definitions for json-schema

Gathering detailed insights and metrics for json-schema-traverse

json-schema-traverse

Traverse JSON Schema passing each schema object to callback

1.0.0

100

MIT

JavaScript

15,399,530,354 3.6

Installations

npm install json-schema-traverse

Pull Requests

Open

6

Total

33

Closed

22

Merged

5

Issues

Open

7

Total

12

Closed

5

Releases

v1.0.0

Published on 13 Dec 2020

v0.5.0

Published on 13 Dec 2020

v0.4.1

Published on 24 Nov 2019

v0.4.0

Published on 08 May 2018

v0.3.0

Published on 08 May 2018

v0.2.0

Published on 14 Jun 2017

View all 7 releases

Developer

epoberezkin

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

14.15.1

NPM Version

6.14.8 Statistics

100 Stars

45 Commits

18 Forks

5 Watching

3 Branches

6 Contributors

Updated on 15 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

15,399,530,354

Last day

-6.5%

20,038,690

Compared to previous day

Last week

2.1%

117,497,919

Compared to previous week

Last month

13.8%

476,327,103

Compared to previous month

Last year

18.2%

4,731,085,548

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

eslint mocha nyc pre-commit

Versions

json-schema-traverse

Traverse JSON Schema passing each schema object to callback

Install

npm install json-schema-traverse

Usage

1const traverse = require('json-schema-traverse');
2const schema = {
3  properties: {
4    foo: {type: 'string'},
5    bar: {type: 'integer'}
6  }
7};
8
9traverse(schema, {cb});
10// cb is called 3 times with:
11// 1. root schema
12// 2. {type: 'string'}
13// 3. {type: 'integer'}
14
15// Or:
16
17traverse(schema, {cb: {pre, post}});
18// pre is called 3 times with:
19// 1. root schema
20// 2. {type: 'string'}
21// 3. {type: 'integer'}
22//
23// post is called 3 times with:
24// 1. {type: 'string'}
25// 2. {type: 'integer'}
26// 3. root schema
27

Callback function cb is called for each schema object (not including draft-06 boolean schemas), including the root schema, in pre-order traversal. Schema references ($ref) are not resolved, they are passed as is. Alternatively, you can pass a {pre, post} object as cb, and then pre will be called before traversing child elements, and post will be called after all child elements have been traversed.

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

1const traverse = require('json-schema-traverse');
2const schema = {
3  mySchema: {
4    minimum: 1,
5    maximum: 2
6  }
7};
8
9traverse(schema, {allKeys: true, cb});
10// cb is called 2 times with:
11// 1. root schema
12// 2. mySchema

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

Enterprise support

json-schema-traverse package is a part of Tidelift enterprise subscription - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers.

Security contact

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues.

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More