Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Phillip Clark committed Nov 19, 2021
1 parent cb11e0b commit 8bf7590
Show file tree
Hide file tree
Showing 6 changed files with 6,033 additions and 99 deletions.
48 changes: 24 additions & 24 deletions docs/classes/jsonpointer.html
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/classes/jsonreference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
<p>A reference to a location in an object graph.</p>
</div><div><p>This type is used by this module to break cycles in an object graph and to
reference locations that have already been visited when enumerating pointers.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">JsonReference</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="JsonReference.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="JsonReference.html#_ref" class="tsd-kind-icon">$ref</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="JsonReference.html#pointer" class="tsd-kind-icon">pointer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JsonReference.html#resolve" class="tsd-kind-icon">resolve</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JsonReference.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="JsonReference.html#isReference" class="tsd-kind-icon">is<wbr/>Reference</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Json<wbr/>Reference<span class="tsd-signature-symbol">(</span>pointer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PathSegments" class="tsd-signature-type" data-tsd-kind="Type alias">PathSegments</a><span class="tsd-signature-symbol"> | </span><a href="JsonPointer.html" class="tsd-signature-type" data-tsd-kind="Class">JsonPointer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="JsonReference.html" class="tsd-signature-type" data-tsd-kind="Class">JsonReference</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/04cb954/src/pointer.ts#L669">pointer.ts:669</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">JsonReference</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="JsonReference.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="JsonReference.html#_ref" class="tsd-kind-icon">$ref</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="JsonReference.html#pointer" class="tsd-kind-icon">pointer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JsonReference.html#resolve" class="tsd-kind-icon">resolve</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JsonReference.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="JsonReference.html#isReference" class="tsd-kind-icon">is<wbr/>Reference</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Json<wbr/>Reference<span class="tsd-signature-symbol">(</span>pointer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PathSegments" class="tsd-signature-type" data-tsd-kind="Type alias">PathSegments</a><span class="tsd-signature-symbol"> | </span><a href="JsonPointer.html" class="tsd-signature-type" data-tsd-kind="Class">JsonPointer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="JsonReference.html" class="tsd-signature-type" data-tsd-kind="Class">JsonReference</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/cb11e0b/src/pointer.ts#L669">pointer.ts:669</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a new instance.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>pointer: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PathSegments" class="tsd-signature-type" data-tsd-kind="Type alias">PathSegments</a><span class="tsd-signature-symbol"> | </span><a href="JsonPointer.html" class="tsd-signature-type" data-tsd-kind="Class">JsonPointer</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>a JSON Pointer for the reference.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="JsonReference.html" class="tsd-signature-type" data-tsd-kind="Class">JsonReference</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_ref" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> $ref</h3><div class="tsd-signature tsd-kind-icon">$ref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/04cb954/src/pointer.ts#L663">pointer.ts:663</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="JsonReference.html" class="tsd-signature-type" data-tsd-kind="Class">JsonReference</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_ref" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> $ref</h3><div class="tsd-signature tsd-kind-icon">$ref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/cb11e0b/src/pointer.ts#L663">pointer.ts:663</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A reference to a position if an object graph.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pointer" class="tsd-anchor"></a><h3>pointer</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pointer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="JsonPointer.html" class="tsd-signature-type" data-tsd-kind="Class">JsonPointer</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/04cb954/src/pointer.ts#L687">pointer.ts:687</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pointer" class="tsd-anchor"></a><h3>pointer</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pointer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="JsonPointer.html" class="tsd-signature-type" data-tsd-kind="Class">JsonPointer</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/cb11e0b/src/pointer.ts#L687">pointer.ts:687</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets the reference&#39;s pointer.</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="JsonPointer.html" class="tsd-signature-type" data-tsd-kind="Class">JsonPointer</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resolve" class="tsd-anchor"></a><h3>resolve</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resolve<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/04cb954/src/pointer.ts#L680">pointer.ts:680</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <a href="JsonPointer.html" class="tsd-signature-type" data-tsd-kind="Class">JsonPointer</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resolve" class="tsd-anchor"></a><h3>resolve</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resolve<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/cb11e0b/src/pointer.ts#L680">pointer.ts:680</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Resolves the reference against the <code>target</code> object, returning the value at
the referenced pointer&#39;s location.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the target object</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/04cb954/src/pointer.ts#L694">pointer.ts:694</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/cb11e0b/src/pointer.ts#L694">pointer.ts:694</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets the reference pointer&#39;s string representation (a URI fragment identifier).</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="isReference" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Reference</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">is<wbr/>Reference<span class="tsd-signature-symbol">(</span>candidate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">candidate</span><span class="tsd-signature-symbol"> is </span><a href="JsonReference.html" class="tsd-signature-type" data-tsd-kind="Class">JsonReference</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/04cb954/src/pointer.ts#L651">pointer.ts:651</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="isReference" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Reference</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">is<wbr/>Reference<span class="tsd-signature-symbol">(</span>candidate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">candidate</span><span class="tsd-signature-symbol"> is </span><a href="JsonReference.html" class="tsd-signature-type" data-tsd-kind="Class">JsonReference</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/flitbit/json-ptr/blob/cb11e0b/src/pointer.ts#L651">pointer.ts:651</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Determines if the specified <code>candidate</code> is a JsonReference.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>candidate: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the candidate</p>
Expand Down
Loading

0 comments on commit 8bf7590

Please sign in to comment.