json-refs

v3.0.15

Various utilities for JSON References (http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03). For more information about how to use this package see README

Latest version published 4 years ago

License: MIT

NPM

GitHub

Package Health Score

76 / 100

security
No known security issues
popularity
Influential project
maintenance
Inactive
community
Active

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

All Versions

Version				Vulnerabilities	License Risk
3.0.15	\|	02/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.7	\|	04/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.0	\|	11/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.2	\|	07/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.0	\|	05/2015		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

Influential project

Weekly Downloads (1,168,339)

GitHub Stars: 221
Forks: 64
Contributors: 20

Direct Usage Popularity

The npm package json-refs receives a total of 1,168,339 downloads a week. As such, we scored json-refs popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package json-refs, we found that it has been starred 221 times.

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

Community

Active

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

With more than 10 contributors for the json-refs 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-refs is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 26
Open PR: 13
Last Release: 4 years ago
Last Commit: 3 years ago

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

An important project maintenance signal to consider for json-refs 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: >=0.8

Age: 9 years
Dependencies: 8 Direct
Versions: 62
Install Size: 3.22 MB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: Yes

json-refs 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-refs?

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

apigee-127 / sway / test / test-path.js View on Github

it('should have proper structure', function () {
      var path = '/pet/{petId}';
      var pathObject = apiDefinition.getOperation(path, 'get').pathObject;

      assert.deepEqual(pathObject.apiDefinition, apiDefinition);
      assert.equal(pathObject.path, path);
      assert.equal(pathObject.ptr, JsonRefs.pathToPtr(['paths', path]));
      assert.deepEqual(pathObject.definition, apiDefinition.definitionRemotesResolved.paths[path]);
      assert.deepEqual(pathObject.definitionFullyResolved, apiDefinition.definitionFullyResolved.paths[path]);

      // Make sure they are of the proper type
      assert.ok(pathObject.regexp instanceof RegExp);

      // Make sure they have the proper keys
      assert.equal(1, pathObject.regexp.keys.length);
      assert.equal('petId', pathObject.regexp.keys[0].name);

      // Make sure they match the expected URLs
      assert.ok(_.isArray(pathObject.regexp.exec(apiDefinition.definitionFullyResolved.basePath + '/pet/1')));
      assert.ok(!_.isArray(pathObject.regexp.exec(apiDefinition.definitionFullyResolved.basePath + '/pets/1')));
      assert.ok(!_.isArray(pathObject.regexp.exec(apiDefinition.definitionFullyResolved.basePath + '/Pet/1')));
    });

View more ways to use json-refs

json-refs

json-refs is a simple library for interacting with JSON References and JSON Pointers. While the main purpose of this library is to provide JSON References features, since JSON References are a combination of Object structure and a JSON Pointer, this library also provides some features for JSON Pointers as well.

Project Badges

Build status:
Dependencies:
Developer dependencies:
Downloads:
Gitter:
License:
Version:

Documentation

The documentation for this project can be found at . Specific documentation can be found here:

API documentation can be found at
CLI can be found at

Installation

json-refs is available for both Node.js and the browser. Installation instructions for each environment are below.

Browser

json-refs binaries for the browser are available in the dist/ directory:

json-refs.js: 2,292kb, full source source maps
json-refs-min.js: 148kb, minified, compressed and no sourcemap

Of course, these links are for the master builds so feel free to download from the release of your choice. Once you've gotten them downloaded, to use the standalone binaries, your HTML include might look like this:

Node.js

Installation for Node.js applications can be done via NPM.

npm install json-refs --save

If you plan on using the json-refs CLI executable, you can install json-refs globally like this:

npm install json-refs --global

After this, feel free to run json-refs help to see what you can do or view the CLI documentation linked above

json-refs dependencies

commander graphlib js-yaml lodash native-promise-only path-loader slash uri-js

FAQs

What is json-refs?

Various utilities for JSON References (http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03). Visit Snyk Advisor to see a full health score report for json-refs, including popularity, security, maintenance & community analysis.

Is json-refs popular?

The npm package json-refs receives a total of 1,168,339 weekly downloads. As such, json-refs popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is json-refs well maintained?

We found indications that json-refs is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is json-refs safe to use?

The npm package json-refs 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 22 April-2024, at 13:20 (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-refs

Various utilities for JSON References (http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03). 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 (1,168,339)

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-refs?

json-refs

Project Badges

Documentation

Installation

Browser

Node.js

json-refs dependencies

json-refs development dependencies

FAQs

What is json-refs?

Is json-refs popular?

Is json-refs well maintained?

Is json-refs 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 (1,168,339)

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-refs?

json-refs

Project Badges

Documentation

Installation

Browser

Node.js

json-refs dependencies

json-refs development dependencies

FAQs

What is json-refs?

Is json-refs popular?

Is json-refs well maintained?

Is json-refs 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