Package Health Score

71 / 100

security
No known security issues
popularity
Popular
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.14.0	\|	10/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.13.0	\|	11/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.10.1	\|	07/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.9.0	\|	02/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.8.0	\|	01/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (555,364)

GitHub Stars: 35
Forks: 24
Contributors: 20

Direct Usage Popularity

The npm package json-schema-deref-sync receives a total of 555,364 downloads a week. As such, we scored json-schema-deref-sync popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package json-schema-deref-sync, we found that it has been starred 35 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the json-schema-deref-sync repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like json-schema-deref-sync is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 5
Open PR: 17
Last Release: 4 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of json-schema-deref-sync based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for json-schema-deref-sync is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=6.0.0

Age: 9 years
Dependencies: 8 Direct
Versions: 30
Install Size: 23.2 kB
Dist-tags: 2
# of Files: 10
Maintainers: 4
TS Typings: No

json-schema-deref-sync has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use json-schema-deref-sync?

To help you get started, we've collected the most common ways that json-schema-deref-sync is being used within popular public projects.

anttiviljami / openapi-client-axios / src / client.ts View on Github

if (this.validate) {
        // validate the document
        this.validateDefinition();
      }
    } catch (err) {
      if (this.strict) {
        // in strict-mode, fail hard and re-throw the error
        throw err;
      } else {
        // just emit a warning about the validation errors
        console.warn(err);
      }
    }

    // dereference the document into definition
    this.definition = dereference(this.inputDocument);

    // create axios instance
    this.instance = this.createAxiosInstance();

    // we are now initalized
    this.initalized = true;
    return this.instance as Client;
  };

View more ways to use json-schema-deref-sync

json-schema-deref-sync

Dereference JSON pointers in a JSON schemas with their true resolved values. Basically a lighter, synchronous version of json-schema-deref but omits web references.

Installation

npm install json-schema-deref-sync

Overview

Let's say you have the following JSON Schema:

{
  "description": "Just some JSON schema.",
  "title": "Basic Widget",
  "type": "object",
  "definitions": {
    "id": {
      "description": "unique identifier",
      "type": "string",
      "minLength": 1,
      "readOnly": true
    }
  },
  "properties": {
    "id": {
      "$ref": "#/definitions/id"
    },
    "bar": {
      "$ref": "bar.json"
    }
  }
}

Sometimes you just want that schema to be fully expanded, with $ref's being their (true) resolved values:

{
  "description": "Just some JSON schema.",
  "title": "Basic Widget",
  "type": "object",
  "definitions": {
    "id": {
      "description": "unique identifier",
      "type": "string",
      "minLength": 1,
      "readOnly": true
    }
  },
  "properties": {
    "id": {
      "description": "unique identifier",
      "type": "string",
      "minLength": 1,
      "readOnly": true
    },
    "bar": {
      "description": "bar property",
      "type": "boolean"
    }
  }
}

This utility lets you do that:

var deref = require('json-schema-deref-sync');
var myschema = require('schema.json');

var fullSchema = deref(myschema);

API Reference

deref(schema, options) ⇒ `Object` | `Error`

Derefs $ref's in JSON Schema to actual resolved values. Supports local, and file refs.

Kind: global function
Returns: Object | Error - the deref schema oran instance of Error if error.

Param	Type	Description
schema	`Object`	The JSON schema
options	`Object`	options
options.baseFolder	`String`	the base folder to get relative path files from. Default is `process.cwd()`
options.failOnMissing	`Boolean`	By default missing / unresolved refs will be left as is with their ref value intact. If set to `true` we will error out on first missing ref that we cannot resolve. Default: `false`.
options.mergeAdditionalProperties	`Boolean`	By default properties in a object with $ref will be removed in the output. If set to `true` they will be added/overwrite the output. This will use lodash's merge function. Default: `false`.
options.removeIds	`Boolean`	By default `$id` fields will get copied when dereferencing. If set to `true` they will be removed. Merged properties will not get removed. Default: `false`.
options.loaders	`Object`	A hash mapping reference types (e.g., 'file') to loader functions.

json-schema-deref-sync dependencies

clone dag-map is-valid-path lodash md5 memory-cache traverse valid-url

json-schema-deref-sync development dependencies

async chai fs.extra js-yaml jsdoc-to-markdown mocha standard

FAQs

What is json-schema-deref-sync?

Simple Node.js JSON Schema dereferencer. Visit Snyk Advisor to see a full health score report for json-schema-deref-sync, including popularity, security, maintenance & community analysis.

Is json-schema-deref-sync popular?

The npm package json-schema-deref-sync receives a total of 555,364 weekly downloads. As such, json-schema-deref-sync popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is json-schema-deref-sync well maintained?

We found indications that json-schema-deref-sync maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is json-schema-deref-sync safe to use?

The npm package json-schema-deref-sync was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 25 July-2024, at 15:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

json-schema-deref-sync

Simple Node.js JSON Schema dereferencer For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (555,364)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Not sure how to use json-schema-deref-sync?

json-schema-deref-sync

Installation

Overview

API Reference

deref(schema, options) ⇒ `Object` | `Error`

json-schema-deref-sync dependencies

json-schema-deref-sync development dependencies

FAQs

What is json-schema-deref-sync?

Is json-schema-deref-sync popular?

Is json-schema-deref-sync well maintained?

Is json-schema-deref-sync safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (555,364)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use json-schema-deref-sync?

json-schema-deref-sync

Installation

Overview

API Reference

deref(schema, options) ⇒ Object | Error

json-schema-deref-sync dependencies

json-schema-deref-sync development dependencies

FAQs

What is json-schema-deref-sync?

Is json-schema-deref-sync popular?

Is json-schema-deref-sync well maintained?

Is json-schema-deref-sync safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

deref(schema, options) ⇒ `Object` | `Error`