Package Exports
- @stoplight/json-ref-resolver
- @stoplight/json-ref-resolver/cache
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stoplight/json-ref-resolver) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
JSON Ref Resolver
Recursively resolves JSON pointers and remote authorities.
Features
- Performant. Hot paths are memoized, remote authorities are resolved concurrently, and the minimum surface area is crawled and resolved.
- Caching. Results from remote authorities are cached.
- Immutable. The original object is not changed, and structural sharing is used to only change relevant bits.
- Reference equality. Pointers to the same location will resolve to the same object in memory.
- Flexible. Bring your own readers for http://, file://, mongo://, custom://... etc.
- Reliable. Well tested to handle all sorts of circular reference edge cases.
Installation
Supported in modern browsers and node.
# latest stable
yarn add @stoplight/json-ref-resolverUsage
All relevant types and options can be found in src/types.ts.
import { Resolver } from '@stoplight/json-ref-resolver';
// some example http library
const request = require('request');
// if we're in node, we create a file reader with fs
const fs = require('fs');
// create our resolver instance
const resolver = new Resolver({
// readers can do anything, so long as they define an async read function that resolves to a value
readers: {
// this reader will be invoked for refs with the https protocol
https: {
async read(ref: uri.URI) {
return request(ref.toString());
},
},
// this reader will be invoked for refs with the file protocol
file: {
async read(ref: uri.URI) {
return fs.read(ref.toString());
},
},
},
});
const resolved = await resolver.resolve({
definitions: {
someOASFile: {
$ref: './main.oas2.yml#/definitions/user',
},
someMarkdownFile: {
$ref: 'https://foo.com/intro.md',
},
},
});
console.log(resolved.result);
// ==> outputs the original object, with refs resolved and replaced
//
// {
// definitions: {
// someOASFile: {
// // ... the data located in the relative file `./main.oas2.yml` and inner json path `#/definitions/user`
// },
// someMarkdownFile: {
// // ... the data located at the url `https://foo.com/intro.md`
// }
// },
// }