Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@chris-armstrong
chris-armstrong committed Mar 1, 2021
1 parent 8875c46 commit 444ff4a
Show file tree
Hide file tree
Showing 17 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/classes/collectionnotfoundexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L55">base/exceptions.ts:55</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L55">base/exceptions.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/configurationexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L80">base/exceptions.ts:80</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L80">base/exceptions.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/conflictexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L8">base/exceptions.ts:8</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L8">base/exceptions.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/indexnotfoundexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L67">base/exceptions.ts:67</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L67">base/exceptions.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalidbatchreplacedeletedescriptorexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L229">base/exceptions.ts:229</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L229">base/exceptions.ts:229</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalidcompositeconditionexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L212">base/exceptions.ts:212</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L212">base/exceptions.ts:212</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalididexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L18">base/exceptions.ts:18</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L18">base/exceptions.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalidindexedfieldvalueexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L96">base/exceptions.ts:96</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L96">base/exceptions.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalidparentidexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L31">base/exceptions.ts:31</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L31">base/exceptions.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalidqueryexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L118">base/exceptions.ts:118</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L118">base/exceptions.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalidupdatesexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L140">base/exceptions.ts:140</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L140">base/exceptions.ts:140</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/invalidupdatevalueexception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/exceptions.ts#L155">base/exceptions.ts:155</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/exceptions.ts#L155">base/exceptions.ts:155</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/accesspattern.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h3>index<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">index<wbr>Name<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/chris-armstrong/dynaglue/blob/f41beef/base/access_pattern.ts#L40">base/access_pattern.ts:40</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/access_pattern.ts#L40">base/access_pattern.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AccessPatternOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/access_pattern.ts#L54">base/access_pattern.ts:54</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/access_pattern.ts#L54">base/access_pattern.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -138,7 +138,7 @@ <h3>partition<wbr>Keys</h3>
<div class="tsd-signature tsd-kind-icon">partition<wbr>Keys<span class="tsd-signature-symbol">:</span> <a href="../modules.html#keypath" class="tsd-signature-type" data-tsd-kind="Type alias">KeyPath</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/access_pattern.ts#L46">base/access_pattern.ts:46</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/access_pattern.ts#L46">base/access_pattern.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -155,7 +155,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> sort<wbr>Keys</h3>
<div class="tsd-signature tsd-kind-icon">sort<wbr>Keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#keypath" class="tsd-signature-type" data-tsd-kind="Type alias">KeyPath</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/access_pattern.ts#L52">base/access_pattern.ts:52</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/access_pattern.ts#L52">base/access_pattern.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
16 changes: 8 additions & 8 deletions docs/interfaces/childcollection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Patterns</
<div class="tsd-signature tsd-kind-icon">access<wbr>Patterns<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="accesspattern.html" class="tsd-signature-type" data-tsd-kind="Interface">AccessPattern</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L22">base/collection.ts:22</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L22">base/collection.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -134,7 +134,7 @@ <h3>foreign<wbr>Key<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">foreign<wbr>Key<wbr>Path<span class="tsd-signature-symbol">:</span> <a href="../modules.html#keypath" class="tsd-signature-type" data-tsd-kind="Type alias">KeyPath</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L89">base/collection.ts:89</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L89">base/collection.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -149,7 +149,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> id<wbr>Generator</h3>
<div class="tsd-signature tsd-kind-icon">id<wbr>Generator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L47">base/collection.ts:47</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L47">base/collection.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -166,7 +166,7 @@ <h3>layout</h3>
<div class="tsd-signature tsd-kind-icon">layout<span class="tsd-signature-symbol">:</span> <a href="collectionlayout.html" class="tsd-signature-type" data-tsd-kind="Interface">CollectionLayout</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L16">base/collection.ts:16</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L16">base/collection.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -184,7 +184,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<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/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L9">base/collection.ts:9</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L9">base/collection.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -200,7 +200,7 @@ <h3>parent<wbr>Collection<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">parent<wbr>Collection<wbr>Name<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/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L84">base/collection.ts:84</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L84">base/collection.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -216,7 +216,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ttl<wbr>Key<wbr>Path<
<div class="tsd-signature tsd-kind-icon">ttl<wbr>Key<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#keypath" class="tsd-signature-type" data-tsd-kind="Type alias">KeyPath</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L40">base/collection.ts:40</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L40">base/collection.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -244,7 +244,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;child&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/collection.ts#L78">base/collection.ts:78</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/collection.ts#L78">base/collection.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
10 changes: 5 additions & 5 deletions docs/interfaces/collectionlayout.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> find<wbr>Keys</h3>
<div class="tsd-signature tsd-kind-icon">find<wbr>Keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#secondaryindexlayout" class="tsd-signature-type" data-tsd-kind="Type alias">SecondaryIndexLayout</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/layout.ts#L50">base/layout.ts:50</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/layout.ts#L50">base/layout.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -122,7 +122,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> index<wbr>Key<wbr>Sep
<div class="tsd-signature tsd-kind-icon">index<wbr>Key<wbr>Separator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/chris-armstrong/dynaglue/blob/f41beef/base/layout.ts#L61">base/layout.ts:61</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/layout.ts#L61">base/layout.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -137,7 +137,7 @@ <h3>primary<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">primary<wbr>Key<span class="tsd-signature-symbol">:</span> <a href="../modules.html#primaryindexlayout" class="tsd-signature-type" data-tsd-kind="Type alias">PrimaryIndexLayout</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/f41beef/base/layout.ts#L46">base/layout.ts:46</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/layout.ts#L46">base/layout.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -152,7 +152,7 @@ <h3>table<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">table<wbr>Name<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/chris-armstrong/dynaglue/blob/f41beef/base/layout.ts#L44">base/layout.ts:44</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/layout.ts#L44">base/layout.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -167,7 +167,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ttl<wbr>Attribute</h3
<div class="tsd-signature tsd-kind-icon">ttl<wbr>Attribute<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/chris-armstrong/dynaglue/blob/f41beef/base/layout.ts#L56">base/layout.ts:56</a></li>
<li>Defined in <a href="https://github.com/chris-armstrong/dynaglue/blob/8875c46/base/layout.ts#L56">base/layout.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 444ff4a

Please sign in to comment.