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.
The documentation for this project can be found at https://github.com/whitlockjc/json-refs/blob/master/docs/README.md. Specific documentation can be found here:
- API documentation can be found at https://github.com/whitlockjc/json-refs/blob/master/docs/API.md
- CLI can be found at https://github.com/whitlockjc/json-refs/blob/master/docs/CLI.md
json-refs is available for both Node.js and the browser. Installation instructions for each environment are below.
Installation for browser applications can be done via Bower or by downloading a standalone binary.
Installation is standard fare:
bower install json-refs --save
To use the Bower install, your HTML includes might look like this:
<!-- ... --> <script src="bower_components/lodash/dist/lodash.min.js"></script> <script src="bower_components/graphlib/dist/graphlib.core.min.js"></script> <script src="bower_components/path-loader/browser/path-loader-min.js"></script> <script src="bower_components/json-refs/browser/json-refs-min.js"></script> <!-- ... -->
The standalone binaries come in two flavors:
- json-refs-standalone.js: 1,904kb, full source source maps
- json-refs-standalone-min.js: 140kb, 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:
<!-- ... --> <script src="json-refs-standalone.js"></script> <!-- ... -->
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