Skip to content
This repository has been archived by the owner on Jun 19, 2023. It is now read-only.

Commit

Permalink
docs: Update documentation for latest release
Browse files Browse the repository at this point in the history
  • Loading branch information
@jeskew
jeskew committed Jun 16, 2018
1 parent 6e4b75b commit 9208302
Show file tree
Hide file tree
Showing 136 changed files with 13,137 additions and 645 deletions.
1 change: 1 addition & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ <h2 id="constituent-packages">Constituent packages</h2>
<li><a href="packages/dynamodb-data-mapper-annotations/">Amazon DynamoDB DataMapper Annotations</a></li>
<li><a href="packages/dynamodb-data-marshaller/">Amazon DynamoDB Data Marshaller</a></li>
<li><a href="packages/dynamodb-expressions/">Amazon DynamoDB Expressions</a></li>
<li><a href="packages/dynamodb-query-iterator/">Amazon DynamoDB Query Iterator</a></li>
</ul>
</div>
</div>
Expand Down
26 changes: 13 additions & 13 deletions docs/packages/dynamodb-auto-marshaller/classes/binaryset.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L8">ObjectSet.ts:8</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L8">ObjectSet.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3>__@to<wbr>String<wbr>Tag</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#___tostringtag">__@toStringTag</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L6">ObjectSet.ts:6</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L6">ObjectSet.ts:6</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -195,7 +195,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _values</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#_values">_values</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L8">ObjectSet.ts:8</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L8">ObjectSet.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -213,7 +213,7 @@ <h3>size</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#size">size</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L102">ObjectSet.ts:102</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L102">ObjectSet.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -239,7 +239,7 @@ <h3>__@iterator</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#___iterator">__@iterator</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L116">ObjectSet.ts:116</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L116">ObjectSet.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -262,7 +262,7 @@ <h3>add</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#add">add</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L29">ObjectSet.ts:29</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L29">ObjectSet.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -295,7 +295,7 @@ <h3>clear</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#clear">clear</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L40">ObjectSet.ts:40</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L40">ObjectSet.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -318,7 +318,7 @@ <h3>delete</h3>
<aside class="tsd-sources">
<p>Overrides <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#delete">delete</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/BinarySet.ts#L11">BinarySet.ts:11</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/BinarySet.ts#L11">BinarySet.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -342,7 +342,7 @@ <h3>entries</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#entries">entries</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L60">ObjectSet.ts:60</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L60">ObjectSet.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -367,7 +367,7 @@ <h3>for<wbr>Each</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#foreach">forEach</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L72">ObjectSet.ts:72</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L72">ObjectSet.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -429,7 +429,7 @@ <h3>has</h3>
<aside class="tsd-sources">
<p>Overrides <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#has">has</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/BinarySet.ts#L37">BinarySet.ts:37</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/BinarySet.ts#L37">BinarySet.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -469,7 +469,7 @@ <h3>keys</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#keys">keys</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L95">ObjectSet.ts:95</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L95">ObjectSet.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -492,7 +492,7 @@ <h3>values</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="objectset.html">ObjectSet</a>.<a href="objectset.html#values">values</a></p>
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L109">ObjectSet.ts:109</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/ObjectSet.ts#L109">ObjectSet.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
10 changes: 5 additions & 5 deletions docs/packages/dynamodb-auto-marshaller/classes/marshaller.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L107">Marshaller.ts:107</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L107">Marshaller.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -142,7 +142,7 @@ <h3>marshall<wbr>Item</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L123">Marshaller.ts:123</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L123">Marshaller.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -176,7 +176,7 @@ <h3>marshall<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L140">Marshaller.ts:140</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L140">Marshaller.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -213,7 +213,7 @@ <h3>unmarshall<wbr>Item</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L168">Marshaller.ts:168</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L168">Marshaller.ts:168</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -243,7 +243,7 @@ <h3>unmarshall<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L175">Marshaller.ts:175</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/Marshaller.ts#L175">Marshaller.ts:175</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
14 changes: 7 additions & 7 deletions docs/packages/dynamodb-auto-marshaller/classes/numbervalue.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L12">NumberValue.ts:12</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L12">NumberValue.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -145,7 +145,7 @@ <h3>__@to<wbr>String<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">__@to<wbr>String<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"DynamoDbNumberValue"</span><span class="tsd-signature-symbol"> =&nbsp;NUMBER_VALUE_TAG</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L12">NumberValue.ts:12</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L12">NumberValue.ts:12</a></li>
</ul>
</aside>
</section>
Expand All @@ -155,7 +155,7 @@ <h3>value</h3>
<div class="tsd-signature tsd-kind-icon">value<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/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L11">NumberValue.ts:11</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L11">NumberValue.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -172,7 +172,7 @@ <h3>toJSON</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L22">NumberValue.ts:22</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L22">NumberValue.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -195,7 +195,7 @@ <h3>to<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L30">NumberValue.ts:30</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L30">NumberValue.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -218,7 +218,7 @@ <h3>value<wbr>Of</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L38">NumberValue.ts:38</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L38">NumberValue.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -241,7 +241,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Number<wbr>Value</
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/e376f1e/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L45">NumberValue.ts:45</a></li>
<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/6e4b75b/packages/dynamodb-auto-marshaller/src/NumberValue.ts#L45">NumberValue.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 9208302

Please sign in to comment.