Skip to content

Commit cc1ce8a

Browse files
committed
fix: update doc configs
1 parent 310627b commit cc1ce8a

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

src/reference-resolver.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@ export default (fetch: any, fs: any) => {
117117
return new Promise((resolve) => fs.readFile(f, "utf8", (err: any, data: any) => resolve(data)));
118118
};
119119

120+
/**
121+
* Given a $ref string, it will return the underlying pointed-to value.
122+
* For remote references, the root object is not used.
123+
*/
120124
const resolveReference = async (ref: string, root: any): Promise<any> => {
121125
if (ref[0] === "#") {
122126
const withoutHash = ref.replace("#", "");

typedoc.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@json-schema-tools/dereferencer",
2+
"name": "@json-schema-tools/reference-resolver",
33
"mode": "file",
44
"inputFiles": [
55
"./src/index.ts"
@@ -14,11 +14,9 @@
1414
"src/*.test.ts"
1515
],
1616
"toc": [
17-
"Dereferencer",
18-
"DereferencerOptions",
17+
"referenceResolver",
1918
"InvalidFileSystemPathError",
2019
"InvalidJsonPointerRefError",
21-
"NonJsonRefError",
22-
"NonStringRefError"
20+
"NonJsonRefError"
2321
]
2422
}

0 commit comments

Comments
 (0)