jsonref

A powerful JavaScript library implementing the JSON Reference and JSON Pointer specifications. Resolve $ref references in JSON documents, handle external references, and manipulate JSON data using JSON Pointer syntax.


Features

- ✅ JSON Reference Resolution: Resolve $ref references in JSON documents
- ✅ External References: Fetch and resolve external URI references
- ✅ JSON Pointer: Navigate and manipulate JSON data using JSON Pointer syntax
- ✅ Caching: Built-in store mechanism for efficient reference caching
- ✅ TypeScript Support: Full TypeScript definitions included
- ✅ Modern ES Modules: Supports both ESM and CommonJS
- ✅ Browser & Node.js: Works in both environments
- ✅ Zero Dependencies: Lightweight with no external dependencies

Installation

``bash


npm

npm install jsonref

pnpm

pnpm add jsonref

yarn

yarn add jsonref
`

Quick Start

$3

`javascript
import { parse } from 'jsonref';

const schema = {
"definitions": {
"person": {
"type": "object",
"properties": {
"name": { "type": "string" }
}
}
},
"type": "object",
"properties": {
"user": { "$ref": "#/definitions/person" }
}
};

const resolved = await parse(schema);
console.log(resolved.properties.user); // { type: "object", properties: { name: { type: "string" } } }
`

$3

`javascript
import { parse } from 'jsonref';

const schema = {
"allOf": [
{ "$ref": "https://json-schema.org/draft/2019-09/schema" },
{ "type": "object" }
]
};

// Define a retriever function to fetch external references
function retriever(url) {
return fetch(url).then(response => response.json());
}

const resolved = await parse(schema, { retriever });
`

API Reference

$3

Resolves all $ref references in a JSON document.

Parameters:
- dataOrUri (object | string): The JSON data to parse or a URI to fetch
- options (object, optional): Configuration options
- scope (string): Base URI for resolving relative references
- store (object): Cache object to store resolved references for reuse
- retriever (function): Function to fetch external references (url: string) => Promise