Skip to content

Commit 1b5eceb

Browse files
Updated documentation links
1 parent 5808771 commit 1b5eceb

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

lib/index.d.ts

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ export = $RefParser
55
/**
66
* This is the default export of JSON Schema $Ref Parser. You can creates instances of this class using new $RefParser(), or you can just call its static methods.
77
*
8-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md
8+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html
99
*/
1010
declare class $RefParser {
1111

1212
/**
1313
* The `schema` property is the parsed/bundled/dereferenced JSON Schema object. This is the same value that is passed to the callback function (or Promise) when calling the parse, bundle, or dereference methods.
1414
*
15-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#schema
15+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#schema
1616
*/
1717
schema: $RefParser.JSONSchema
1818

@@ -21,7 +21,7 @@ declare class $RefParser {
2121
*
2222
* This is the same value that is passed to the callback function (or Promise) when calling the `resolve` method.
2323
*
24-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#refs
24+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#refs
2525
*/
2626
$refs: $RefParser.$Refs
2727

@@ -30,7 +30,7 @@ declare class $RefParser {
3030
*
3131
* The dereference method maintains object reference equality, meaning that all `$ref` pointers that point to the same object will be replaced with references to the same object. Again, this is great for programmatic usage, but it does introduce the risk of circular references, so be careful if you intend to serialize the schema using `JSON.stringify()`. Consider using the bundle method instead, which does not create circular references.
3232
*
33-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#dereferenceschema-options-callback
33+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#dereferenceschema-options-callback
3434
*
3535
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
3636
* @param options (optional)
@@ -48,7 +48,7 @@ declare class $RefParser {
4848
*
4949
* The dereference method maintains object reference equality, meaning that all `$ref` pointers that point to the same object will be replaced with references to the same object. Again, this is great for programmatic usage, but it does introduce the risk of circular references, so be careful if you intend to serialize the schema using `JSON.stringify()`. Consider using the bundle method instead, which does not create circular references.
5050
*
51-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#dereferenceschema-options-callback
51+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#dereferenceschema-options-callback
5252
*
5353
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
5454
* @param options (optional)
@@ -66,7 +66,7 @@ declare class $RefParser {
6666
*
6767
* This also eliminates the risk of circular references, so the schema can be safely serialized using `JSON.stringify()`.
6868
*
69-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#bundleschema-options-callback
69+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#bundleschema-options-callback
7070
*
7171
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
7272
* @param options (optional)
@@ -84,7 +84,7 @@ declare class $RefParser {
8484
*
8585
* This also eliminates the risk of circular references, so the schema can be safely serialized using `JSON.stringify()`.
8686
*
87-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#bundleschema-options-callback
87+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#bundleschema-options-callback
8888
*
8989
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
9090
* @param options (optional)
@@ -102,7 +102,7 @@ declare class $RefParser {
102102
*
103103
* Parses the given JSON Schema file (in JSON or YAML format), and returns it as a JavaScript object. This method `does not` resolve `$ref` pointers or dereference anything. It simply parses one file and returns it.
104104
*
105-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#parseschema-options-callback
105+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#parseschema-options-callback
106106
*
107107
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. The path can be absolute or relative. In Node, the path is relative to `process.cwd()`. In the browser, it's relative to the URL of the page.
108108
* @param options (optional)
@@ -120,7 +120,7 @@ declare class $RefParser {
120120
*
121121
* Parses the given JSON Schema file (in JSON or YAML format), and returns it as a JavaScript object. This method `does not` resolve `$ref` pointers or dereference anything. It simply parses one file and returns it.
122122
*
123-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#parseschema-options-callback
123+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#parseschema-options-callback
124124
*
125125
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. The path can be absolute or relative. In Node, the path is relative to `process.cwd()`. In the browser, it's relative to the URL of the page.
126126
* @param options (optional)
@@ -138,7 +138,7 @@ declare class $RefParser {
138138
*
139139
* Resolves all JSON references (`$ref` pointers) in the given JSON Schema file. If it references any other files/URLs, then they will be downloaded and resolved as well. This method **does not** dereference anything. It simply gives you a `$Refs` object, which is a map of all the resolved references and their values.
140140
*
141-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#resolveschema-options-callback
141+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#resolveschema-options-callback
142142
*
143143
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
144144
* @param options (optional)
@@ -156,7 +156,7 @@ declare class $RefParser {
156156
*
157157
* Resolves all JSON references (`$ref` pointers) in the given JSON Schema file. If it references any other files/URLs, then they will be downloaded and resolved as well. This method **does not** dereference anything. It simply gives you a `$Refs` object, which is a map of all the resolved references and their values.
158158
*
159-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#resolveschema-options-callback
159+
* See https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#resolveschema-options-callback
160160
*
161161
* @param schema A JSON Schema object, or the file path or URL of a JSON Schema file. See the `parse` method for more info.
162162
* @param options (optional)
@@ -177,7 +177,7 @@ declare namespace $RefParser {
177177
export type $RefsCallback = (err: Error | null, $refs?: $Refs) => any;
178178

179179
/**
180-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/options.md
180+
* See https://apitools.dev/json-schema-ref-parser/docs/options.html
181181
*/
182182
export type Options = {
183183

@@ -252,7 +252,7 @@ declare namespace $RefParser {
252252
/**
253253
* JSON Schema `$Ref` Parser comes with built-in resolvers for HTTP and HTTPS URLs, as well as local filesystem paths (when running in Node.js). You can add your own custom resolvers to support additional protocols, or even replace any of the built-in resolvers with your own custom implementation.
254254
*
255-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/plugins/resolvers.md
255+
* See https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html
256256
*/
257257
export interface ResolverOptions {
258258

@@ -303,7 +303,7 @@ declare namespace $RefParser {
303303
canParse?: boolean | RegExp | string | string[] | ((file: FileInfo) => boolean)
304304

305305
/**
306-
* This is where the real work of a parser happens. The `parse` method accepts the same [file info object](file-info-object.md) as the `canParse` function, but rather than returning a boolean value, the `parse` method should return a JavaScript representation of the file contents. For our CSV parser, that is a two-dimensional array of lines and values. For your parser, it might be an object, a string, a custom class, or anything else.
306+
* This is where the real work of a parser happens. The `parse` method accepts the same file info object as the `canParse` function, but rather than returning a boolean value, the `parse` method should return a JavaScript representation of the file contents. For our CSV parser, that is a two-dimensional array of lines and values. For your parser, it might be an object, a string, a custom class, or anything else.
307307
*
308308
* Unlike the `canParse` function, the `parse` method can also be asynchronous. This might be important if your parser needs to retrieve data from a database or if it relies on an external HTTP service to return the parsed value. You can return your asynchronous value via a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) or a Node.js-style error-first callback. Here are examples of both approaches:
309309
*/
@@ -318,7 +318,7 @@ declare namespace $RefParser {
318318
*
319319
* The file info object currently only consists of a few properties, but it may grow in the future if plug-ins end up needing more information.
320320
*
321-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/plugins/file-info-object.md
321+
* See https://apitools.dev/json-schema-ref-parser/docs/plugins/file-info-object.html
322322
*/
323323
export interface FileInfo {
324324

@@ -343,20 +343,20 @@ declare namespace $RefParser {
343343
*
344344
* This object is a map of JSON References and their resolved values. It also has several convenient helper methods that make it easy for you to navigate and manipulate the JSON References.
345345
*
346-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/refs.md
346+
* See https://apitools.dev/json-schema-ref-parser/docs/refs.html
347347
*/
348348
export class $Refs {
349349
/**
350350
* This property is true if the schema contains any circular references. You may want to check this property before serializing the dereferenced schema as JSON, since JSON.stringify() does not support circular references by default.
351351
*
352-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/refs.md#circular
352+
* See https://apitools.dev/json-schema-ref-parser/docs/refs.html#circular
353353
*/
354354
circular: boolean
355355

356356
/**
357357
* Returns the paths/URLs of all the files in your schema (including the main schema file).
358358
*
359-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/refs.md#pathstypes
359+
* See https://apitools.dev/json-schema-ref-parser/docs/refs.html#pathstypes
360360
*
361361
* @param types (optional) Optionally only return certain types of paths ("file", "http", etc.)
362362
*/
@@ -365,7 +365,7 @@ declare namespace $RefParser {
365365
/**
366366
* Returns a map of paths/URLs and their correspond values.
367367
*
368-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/refs.md#valuestypes
368+
* See https://apitools.dev/json-schema-ref-parser/docs/refs.html#valuestypes
369369
*
370370
* @param types (optional) Optionally only return values from certain locations ("file", "http", etc.)
371371
*/
@@ -374,7 +374,7 @@ declare namespace $RefParser {
374374
/**
375375
* Returns `true` if the given path exists in the schema; otherwise, returns `false`
376376
*
377-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/refs.md#existsref
377+
* See https://apitools.dev/json-schema-ref-parser/docs/refs.html#existsref
378378
*
379379
* @param $ref The JSON Reference path, optionally with a JSON Pointer in the hash
380380
*/
@@ -383,7 +383,7 @@ declare namespace $RefParser {
383383
/**
384384
* Gets the value at the given path in the schema. Throws an error if the path does not exist.
385385
*
386-
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/refs.md#getref
386+
* See https://apitools.dev/json-schema-ref-parser/docs/refs.html#getref
387387
*
388388
* @param $ref The JSON Reference path, optionally with a JSON Pointer in the hash
389389
*/

0 commit comments

Comments
 (0)