npmpackage.info

async-json-schema-traverse

Traverse JSON Schema passing each schema object to callback

1.0.1

MIT

JavaScript

645.00 B

1,669 3.4

Installations

npm install async-json-schema-traverse

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

10.19.0

NPM Version

6.13.4 Score

69.5

Supply Chain

Quality

75.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

moderncrazy

Download Statistics

Total Downloads

1,669

Last Day

Last Week

198

Last Month

813

Last Year

1,063

GitHub Statistics

47 Commits

1 Branches

1 Contributors

Bundle Size

1.35 kB

Minified

645.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.1

Package Id

async-json-schema-traverse@1.0.1

Unpacked Size

8.59 kB

Size

3.37 kB

File Count

NPM Version

6.13.4

Node Version

10.19.0

Total Downloads

Cumulative downloads

Total Downloads

1,669

Last day

80%

Compared to previous day

Last week

-4.8%

198

Compared to previous week

Last month

323.4%

813

Compared to previous month

Last year

392.1%

1,063

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

eslint mocha nyc pre-commit

Versions

async-json-schema-traverse

Traverse JSON Schema passing each schema object to callback (fork json-schema-traverse)

Install

npm install async-json-schema-traverse

Usage

1const traverse = require('async-json-schema-traverse');
2const schema = {
3  properties: {
4    foo: {type: 'string'},
5    bar: {type: 'integer'}
6  }
7};
8
9await traverse(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
17await traverse(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('async-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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

Pinned-Dependencies

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

0

Token-Permissions

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

0

SAST

Determines if the project uses static code analysis.

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.

Score

3.4

/10

Last Scanned on 2025-01-27

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

Other packages similar to async-json-schema-traverse

@firanorg/mollitia-molestias-accusamus

10.13.142

[![github actions][actions-image]][actions-url] [![coverage][codecov-image]][codecov-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url]

@taktikorg/vero-eligendi

3.9.98

@teamteanpm2024/ab-deserunt-culpa

1.2.4

> Generates Typescript/Javascript [decoders](https://decoders.cc) source code expressions from JSON schema specifications.

@patrtorg/ea-cupiditate-aperiam

5.8.92

[![github actions][actions-image]][actions-url] [![coverage][codecov-image]][codecov-url] [![dependency status][deps-svg]][deps-url] [![dev dependency status][dev-deps-svg]][dev-deps-url] [![License][license-image]][license-url] [![Downloads][downloads-im