https://github.com/cvent/json-schema-deref-sync
Synchronous json schema dereference utility
https://github.com/cvent/json-schema-deref-sync
Last synced: 5 months ago
JSON representation
Synchronous json schema dereference utility
- Host: GitHub
- URL: https://github.com/cvent/json-schema-deref-sync
- Owner: cvent
- License: mit
- Created: 2015-03-17T00:08:15.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-11-15T01:09:34.000Z (7 months ago)
- Last Synced: 2025-11-15T03:20:14.275Z (7 months ago)
- Language: JavaScript
- Homepage: http://bojand.github.io/json-schema-deref-sync
- Size: 420 KB
- Stars: 36
- Watchers: 3
- Forks: 24
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# json-schema-deref-sync
[](https://www.npmjs.com/package/json-schema-deref-sync)
[](https://travis-ci.org/bojand/json-schema-deref-sync)
[](https://standardjs.com)
[](https://raw.githubusercontent.com/bojand/json-schema-deref-sync/master/LICENSE)
Dereference JSON pointers in a JSON schemas with their true resolved values.
Basically a lighter, synchronous version of [json-schema-deref](https://github.com/bojand/json-schema-deref) but omits web references.
## Installation
`npm install json-schema-deref-sync`
## Overview
Let's say you have the following JSON Schema:
```json
{
"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:
```json
{
"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:
```js
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. |