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

Commit 7281d2f

Browse files
committed
Regenerate documentation
1 parent 627244c commit 7281d2f

File tree

11 files changed

+43
-67
lines changed

11 files changed

+43
-67
lines changed

docs/classes/BatchGet.html

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

docs/classes/BatchWrite.html

Lines changed: 9 additions & 9 deletions
Large diffs are not rendered by default.

docs/index.html

Lines changed: 14 additions & 38 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchGetOptions | @aws/dynamodb-batch-iterator</title><meta name="description" content="Documentation for @aws/dynamodb-batch-iterator"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@aws/dynamodb-batch-iterator</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@aws/dynamodb-batch-iterator</a></li><li><a href="BatchGetOptions.html">BatchGetOptions</a></li></ul><h1>Interface BatchGetOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BatchGetOptions</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchGetOptions.html#ConsistentRead" class="tsd-kind-icon">Consistent<wbr/>Read</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchGetOptions.html#PerTableOptions" class="tsd-kind-icon">Per<wbr/>Table<wbr/>Options</a></li></ul></section></div></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-interface"><a id="ConsistentRead" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Consistent<wbr/>Read</h3><div class="tsd-signature tsd-kind-icon">Consistent<wbr/>Read<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/931831f/src/BatchGetOptions.ts#L7">BatchGetOptions.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchGetOptions | dynamodb-batch-iterator</title><meta name="description" content="Documentation for dynamodb-batch-iterator"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">dynamodb-batch-iterator</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">dynamodb-batch-iterator</a></li><li><a href="BatchGetOptions.html">BatchGetOptions</a></li></ul><h1>Interface BatchGetOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BatchGetOptions</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchGetOptions.html#ConsistentRead" class="tsd-kind-icon">Consistent<wbr/>Read</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchGetOptions.html#PerTableOptions" class="tsd-kind-icon">Per<wbr/>Table<wbr/>Options</a></li></ul></section></div></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-interface"><a id="ConsistentRead" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Consistent<wbr/>Read</h3><div class="tsd-signature tsd-kind-icon">Consistent<wbr/>Read<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bas-d/dynamodb-batch-iterator/blob/627244c/src/BatchGetOptions.ts#L7">BatchGetOptions.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
22
<p>The default read consistency to apply to gets.</p>
3-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PerTableOptions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Per<wbr/>Table<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">Per<wbr/>Table<wbr/>Options<span class="tsd-signature-symbol">?:</span> <a href="PerTableOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PerTableOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/931831f/src/BatchGetOptions.ts#L12">BatchGetOptions.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
3+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PerTableOptions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Per<wbr/>Table<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">Per<wbr/>Table<wbr/>Options<span class="tsd-signature-symbol">?:</span> <a href="PerTableOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PerTableOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bas-d/dynamodb-batch-iterator/blob/627244c/src/BatchGetOptions.ts#L12">BatchGetOptions.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
44
<p>Options to apply for all reads directed to a specific table.</p>
55
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="BatchGetOptions.html" class="tsd-kind-icon">Batch<wbr/>Get<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchGetOptions.html#ConsistentRead" class="tsd-kind-icon">Consistent<wbr/>Read</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchGetOptions.html#PerTableOptions" class="tsd-kind-icon">Per<wbr/>Table<wbr/>Options</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)