@karmaniverous/entity-manager 5.0.8 → 5.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/.github/FUNDING.yml +3 -0
  2. package/README.md +1 -2
  3. package/dist/cjs/BaseEntityClient/BaseEntityClient.js +28 -0
  4. package/dist/cjs/BaseQueryBuilder/BaseQueryBuilder.js +62 -0
  5. package/dist/cjs/EntityManager/EntityManager.js +131 -0
  6. package/dist/cjs/EntityManager/ParsedConfig.js +385 -0
  7. package/dist/cjs/EntityManager/addKeys.js +60 -0
  8. package/dist/cjs/EntityManager/createEntityManager.js +46 -0
  9. package/dist/cjs/EntityManager/decodeElement.js +46 -0
  10. package/dist/cjs/EntityManager/decodeGeneratedProperty.js +53 -0
  11. package/dist/cjs/EntityManager/dehydrateIndexItem.js +68 -0
  12. package/dist/cjs/EntityManager/dehydratePageKeyMap.js +93 -0
  13. package/dist/cjs/EntityManager/encodeElement.js +40 -0
  14. package/dist/cjs/EntityManager/encodeGeneratedProperty.js +55 -0
  15. package/dist/cjs/EntityManager/findIndexToken.js +10 -0
  16. package/dist/cjs/EntityManager/getHashKeySpace.js +89 -0
  17. package/dist/cjs/EntityManager/getIndexComponents.js +23 -0
  18. package/dist/cjs/EntityManager/getPrimaryKey.js +76 -0
  19. package/dist/cjs/EntityManager/getShardBump.js +24 -0
  20. package/dist/cjs/EntityManager/query.js +130 -0
  21. package/dist/cjs/EntityManager/rehydrateIndexItem.js +65 -0
  22. package/dist/cjs/EntityManager/rehydratePageKeyMap.js +103 -0
  23. package/dist/cjs/EntityManager/removeKeys.js +51 -0
  24. package/dist/cjs/EntityManager/unwrapIndex.js +59 -0
  25. package/dist/cjs/EntityManager/updateItemHashKey.js +79 -0
  26. package/dist/cjs/EntityManager/updateItemRangeKey.js +65 -0
  27. package/dist/cjs/EntityManager/validateEntityToken.js +17 -0
  28. package/dist/cjs/EntityManager/validateGeneratedProperty.js +23 -0
  29. package/dist/cjs/EntityManager/validateIndexToken.js +16 -0
  30. package/dist/cjs/EntityManager/validateTranscodedProperty.js +16 -0
  31. package/dist/cjs/index.js +15 -0
  32. package/dist/default/lib/EntityManager/EntityManager.js +46 -69
  33. package/dist/default/lib/EntityManager/PrivateEntityManager.js +44 -51
  34. package/dist/index.d.ts +1163 -0
  35. package/dist/mjs/BaseEntityClient/BaseEntityClient.js +26 -0
  36. package/dist/mjs/BaseQueryBuilder/BaseQueryBuilder.js +60 -0
  37. package/dist/mjs/EntityManager/EntityManager.js +129 -0
  38. package/dist/mjs/EntityManager/ParsedConfig.js +383 -0
  39. package/dist/mjs/EntityManager/addKeys.js +58 -0
  40. package/dist/mjs/EntityManager/createEntityManager.js +44 -0
  41. package/dist/mjs/EntityManager/decodeElement.js +44 -0
  42. package/dist/mjs/EntityManager/decodeGeneratedProperty.js +51 -0
  43. package/dist/mjs/EntityManager/dehydrateIndexItem.js +66 -0
  44. package/dist/mjs/EntityManager/dehydratePageKeyMap.js +91 -0
  45. package/dist/mjs/EntityManager/encodeElement.js +38 -0
  46. package/dist/mjs/EntityManager/encodeGeneratedProperty.js +53 -0
  47. package/dist/mjs/EntityManager/findIndexToken.js +8 -0
  48. package/dist/mjs/EntityManager/getHashKeySpace.js +87 -0
  49. package/dist/mjs/EntityManager/getIndexComponents.js +21 -0
  50. package/dist/mjs/EntityManager/getPrimaryKey.js +74 -0
  51. package/dist/mjs/EntityManager/getShardBump.js +22 -0
  52. package/dist/mjs/EntityManager/query.js +128 -0
  53. package/dist/mjs/EntityManager/rehydrateIndexItem.js +63 -0
  54. package/dist/mjs/EntityManager/rehydratePageKeyMap.js +101 -0
  55. package/dist/mjs/EntityManager/removeKeys.js +49 -0
  56. package/dist/mjs/EntityManager/unwrapIndex.js +57 -0
  57. package/dist/mjs/EntityManager/updateItemHashKey.js +77 -0
  58. package/dist/mjs/EntityManager/updateItemRangeKey.js +63 -0
  59. package/dist/mjs/EntityManager/validateEntityToken.js +15 -0
  60. package/dist/mjs/EntityManager/validateGeneratedProperty.js +21 -0
  61. package/dist/mjs/EntityManager/validateIndexToken.js +14 -0
  62. package/dist/mjs/EntityManager/validateTranscodedProperty.js +14 -0
  63. package/dist/mjs/index.js +5 -0
  64. package/docs/.nojekyll +1 -0
  65. package/docs/assets/hierarchy.js +1 -0
  66. package/docs/assets/highlight.css +99 -0
  67. package/docs/assets/icons.js +18 -0
  68. package/docs/assets/icons.svg +1 -0
  69. package/docs/assets/main.js +60 -0
  70. package/docs/assets/navigation.js +1 -0
  71. package/docs/assets/search.js +1 -0
  72. package/docs/assets/style.css +1648 -0
  73. package/docs/classes/index.BaseEntityClient.html +124 -0
  74. package/docs/classes/index.BaseQueryBuilder.html +229 -0
  75. package/docs/classes/index.EntityManager.html +510 -0
  76. package/docs/documents/CHANGELOG.html +1432 -0
  77. package/docs/documents/guides_stan-assistant-guide.html +431 -0
  78. package/docs/functions/index.createEntityManager.html +60 -0
  79. package/docs/hierarchy.html +31 -0
  80. package/docs/index.html +212 -0
  81. package/docs/interfaces/index.BaseConfigMap.html +113 -0
  82. package/docs/interfaces/index.BaseEntityClientOptions.html +82 -0
  83. package/docs/interfaces/index.BaseQueryBuilderOptions.html +92 -0
  84. package/docs/interfaces/index.CapturedConfigMapFrom.html +126 -0
  85. package/docs/interfaces/index.ConfigInput.html +189 -0
  86. package/docs/interfaces/index.ParsedConfig.html +144 -0
  87. package/docs/interfaces/index.ParsedEntityConfig.html +91 -0
  88. package/docs/interfaces/index.ParsedGeneratedPropertiesConfig.html +67 -0
  89. package/docs/interfaces/index.ParsedIndexConfig.html +79 -0
  90. package/docs/interfaces/index.ParsedTranscoder.html +71 -0
  91. package/docs/interfaces/index.QueryOptions.html +180 -0
  92. package/docs/interfaces/index.QueryResult.html +91 -0
  93. package/docs/interfaces/index.ShardBump.html +79 -0
  94. package/docs/interfaces/index.ShardQueryResult.html +93 -0
  95. package/docs/modules/index.html +47 -0
  96. package/docs/modules.html +38 -0
  97. package/docs/sitemap.xml +263 -0
  98. package/docs/types/index.BaseKeyTokens.html +39 -0
  99. package/docs/types/index.Config.html +75 -0
  100. package/docs/types/index.ConfigMap.html +41 -0
  101. package/docs/types/index.ConfigOfClient.html +45 -0
  102. package/docs/types/index.EntitiesFromSchema.html +39 -0
  103. package/docs/types/index.EntityClientItemByToken.html +45 -0
  104. package/docs/types/index.EntityClientRecordByToken.html +43 -0
  105. package/docs/types/index.EntityItem.html +41 -0
  106. package/docs/types/index.EntityItemPartial.html +44 -0
  107. package/docs/types/index.EntityKey.html +40 -0
  108. package/docs/types/index.EntityOfToken.html +39 -0
  109. package/docs/types/index.EntityRecord.html +39 -0
  110. package/docs/types/index.EntityRecordPartial.html +40 -0
  111. package/docs/types/index.EntityToken.html +40 -0
  112. package/docs/types/index.FallbackIndexTokenSet.html +40 -0
  113. package/docs/types/index.HasIndexFor.html +43 -0
  114. package/docs/types/index.HashKeyFrom.html +38 -0
  115. package/docs/types/index.IndexComponentTokens.html +45 -0
  116. package/docs/types/index.IndexHashKeyOf.html +42 -0
  117. package/docs/types/index.IndexRangeKeyOf.html +41 -0
  118. package/docs/types/index.IndexTokensFrom.html +41 -0
  119. package/docs/types/index.IndexTokensOf.html +40 -0
  120. package/docs/types/index.KeysFrom.html +38 -0
  121. package/docs/types/index.PageKey.html +40 -0
  122. package/docs/types/index.PageKeyByIndex.html +46 -0
  123. package/docs/types/index.PresentIndexTokenSet.html +45 -0
  124. package/docs/types/index.Projected.html +39 -0
  125. package/docs/types/index.QueryBuilderQueryOptions.html +45 -0
  126. package/docs/types/index.QueryOptionsByCC.html +49 -0
  127. package/docs/types/index.QueryOptionsByCF.html +47 -0
  128. package/docs/types/index.RangeKeyFrom.html +38 -0
  129. package/docs/types/index.ShardQueryFunction.html +63 -0
  130. package/docs/types/index.ShardQueryMap.html +56 -0
  131. package/docs/types/index.ShardQueryMapByCC.html +49 -0
  132. package/docs/types/index.ShardQueryMapByCF.html +47 -0
  133. package/docs/types/index.ShardedKeysFrom.html +38 -0
  134. package/docs/types/index.StorageItem.html +42 -0
  135. package/docs/types/index.StorageRecord.html +40 -0
  136. package/docs/types/index.TranscodedPropertiesFrom.html +38 -0
  137. package/docs/types/index.UnshardedKeysFrom.html +38 -0
  138. package/docs/types/index.ValidateConfigMap.html +40 -0
  139. package/lib/EntityManager/PrivateEntityManager.js +4 -0
  140. package/package.json +6 -6
package/docs/interfaces/index.QueryOptions.html ADDED
@@ -0,0 +1,180 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryOptions | @karmaniverous/entity-manager</title><meta name="description" content="Documentation for @karmaniverous/entity-manager"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="https://github.com/karmaniverous/entity-manager" class="title">@karmaniverous/entity-manager</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/index.html">index</a></li>
12
+ <li><a href="" aria-current="page">QueryOptions</a></li></ul>
13
+ <h1>Interface QueryOptions&lt;CC, ET, ITS, CF, K&gt;<code class="tsd-tag">Protected</code></h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>Options passed to the <a href="../classes/index.EntityManager.html#query" class="tsd-kind-method"><code>EntityManager.query</code></a> method.</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">QueryOptions</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a> <span class="tsd-signature-keyword">extends</span> <a href="index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">=</span> <a href="../types/index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#entitytoken">entityToken</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#item">item</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.EntityItemPartial.html" class="tsd-signature-type tsd-kind-type-alias">EntityItemPartial</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pagekeymap">pageKeyMap</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pagesize">pageSize</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#shardquerymap">shardQueryMap</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.ShardQueryMap.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryMap</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#sortorder">sortOrder</a><span class="tsd-signature-symbol">?:</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.SortOrder.html" class="tsd-signature-type external" target="_blank">SortOrder</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/index.EntityItemPartial.html" class="tsd-signature-type tsd-kind-type-alias">EntityItemPartial</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#throttle">throttle</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#timestampfrom">timestampFrom</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#timestampto">timestampTo</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
18
+ <section class="tsd-panel">
19
+ <h4>Type Parameters</h4>
20
+ <ul class="tsd-type-parameter-list">
21
+ <li><span id="cc"><span class="tsd-kind-type-parameter">CC</span> <span class="tsd-signature-keyword">extends</span> <a href="index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a></span>
22
+ <div class="tsd-comment tsd-typography"><p><a href="../types/index.ConfigMap.html" class="tsd-kind-type-alias"><code>ConfigMap</code></a> that defines an <a href="../types/index.Config.html" class="tsd-kind-type-alias"><code>EntityManager configuration</code></a>'s <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.EntityMap.html"><code>EntityMap</code></a>, key properties, and <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.TranscodeRegistry.html"><code>TranscodeRegistry</code></a>. If omitted, defaults to <a href="index.BaseConfigMap.html" class="tsd-kind-interface"><code>BaseConfigMap</code></a>.</p>
23
+ </div></li>
24
+ <li><span id="et"><span class="tsd-kind-type-parameter">ET</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span> = <a href="../types/index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span></span>
25
+ <div class="tsd-comment tsd-typography"><p>Entity token narrowing the item types.</p>
26
+ </div></li>
27
+ <li><span id="its"><span class="tsd-kind-type-parameter">ITS</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> = <span class="tsd-signature-type">string</span></span>
28
+ <div class="tsd-comment tsd-typography"><p>Index token subset (inferred from shardQueryMap keys).</p>
29
+ </div></li>
30
+ <li><span id="cf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span>
31
+ <div class="tsd-comment tsd-typography"><p>Optional values-first config literal type used for index-aware narrowing.</p>
32
+ </div></li>
33
+ <li><span id="k"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span>
34
+ <div class="tsd-comment tsd-typography"><p>Optional projection keys; narrows item/sort shapes when provided.</p>
35
+ </div></li></ul></section><aside class="tsd-sources">
36
+ <ul>
37
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L30">EntityManager/QueryOptions.ts:30</a></li></ul></aside>
38
+ <section class="tsd-panel-group tsd-index-group">
39
+ <section class="tsd-panel tsd-index-panel">
40
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
41
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
42
+ <div class="tsd-accordion-details">
43
+ <section class="tsd-index-section">
44
+ <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
45
+ <div class="tsd-index-list"><a href="#entitytoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Token</span></a>
46
+ <a href="#item" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>item</span></a>
47
+ <a href="#limit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>limit?</span></a>
48
+ <a href="#pagekeymap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Key<wbr/>Map?</span></a>
49
+ <a href="#pagesize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Size?</span></a>
50
+ <a href="#shardquerymap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shard<wbr/>Query<wbr/>Map</span></a>
51
+ <a href="#sortorder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Order?</span></a>
52
+ <a href="#throttle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>throttle?</span></a>
53
+ <a href="#timestampfrom" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp<wbr/>From?</span></a>
54
+ <a href="#timestampto" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp<wbr/>To?</span></a>
55
+ </div></section></div></details></section></section>
56
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
57
+ <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
58
+ <section>
59
+ <section class="tsd-panel tsd-member">
60
+ <h3 class="tsd-anchor-link" id="entitytoken"><span>entity<wbr/>Token</span><a href="#entitytoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
61
+ <div class="tsd-signature"><span class="tsd-kind-property">entityToken</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a></div>
62
+ <div class="tsd-comment tsd-typography"><p>Identifies the entity to be queried. Key of <a href="../types/index.Config.html" class="tsd-kind-type-alias"><code>Config</code></a> <code>entities</code>.</p>
63
+ </div><aside class="tsd-sources">
64
+ <ul>
65
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L38">EntityManager/QueryOptions.ts:38</a></li></ul></aside></section>
66
+ <section class="tsd-panel tsd-member">
67
+ <h3 class="tsd-anchor-link" id="item"><span>item</span><a href="#item" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
68
+ <div class="tsd-signature"><span class="tsd-kind-property">item</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.EntityItemPartial.html" class="tsd-signature-type tsd-kind-type-alias">EntityItemPartial</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">&gt;</span></div>
69
+ <div class="tsd-comment tsd-typography"><p>Partial item object sufficiently populated to generate index hash keys.</p>
70
+ </div><aside class="tsd-sources">
71
+ <ul>
72
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L43">EntityManager/QueryOptions.ts:43</a></li></ul></aside></section>
73
+ <section class="tsd-panel tsd-member">
74
+ <h3 class="tsd-anchor-link" id="limit"><code class="tsd-tag">Optional</code><span>limit</span><a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
75
+ <div class="tsd-signature"><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
76
+ <div class="tsd-comment tsd-typography"><p>The target maximum number of records to be returned by the query across
77
+ all shards.</p>
78
+ <p>The actual number of records returned will be a product of <a href="#pagesize" class="tsd-kind-property"><code>pageSize</code></a> and the
79
+ number of shards queried, unless limited by available records in a given
80
+ shard.</p>
81
+ </div><aside class="tsd-sources">
82
+ <ul>
83
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L53">EntityManager/QueryOptions.ts:53</a></li></ul></aside></section>
84
+ <section class="tsd-panel tsd-member">
85
+ <h3 class="tsd-anchor-link" id="pagekeymap"><code class="tsd-tag">Optional</code><span>page<wbr/>Key<wbr/>Map</span><a href="#pagekeymap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
86
+ <div class="tsd-signature"><span class="tsd-kind-property">pageKeyMap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
87
+ <div class="tsd-comment tsd-typography"><p><a href="index.QueryResult.html#pagekeymap" class="tsd-kind-property"><code>pageKeyMap</code></a> returned by the previous iteration of this query.</p>
88
+ </div><aside class="tsd-sources">
89
+ <ul>
90
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L58">EntityManager/QueryOptions.ts:58</a></li></ul></aside></section>
91
+ <section class="tsd-panel tsd-member">
92
+ <h3 class="tsd-anchor-link" id="pagesize"><code class="tsd-tag">Optional</code><span>page<wbr/>Size</span><a href="#pagesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
93
+ <div class="tsd-signature"><span class="tsd-kind-property">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
94
+ <div class="tsd-comment tsd-typography"><p>The maximum number of records to be returned by each individual query to a
95
+ single shard (i.e. <a href="../types/index.ShardQueryFunction.html" class="tsd-kind-type-alias"><code>ShardQueryFunction</code></a> execution).</p>
96
+ <p>Note that, within a given <a href="../classes/index.EntityManager.html#query" class="tsd-kind-method"><code>query</code></a> method execution, these queries will be
97
+ repeated until either available data is exhausted or the <a href="#limit" class="tsd-kind-property"><code>limit</code></a> value is
98
+ reached.</p>
99
+ </div><aside class="tsd-sources">
100
+ <ul>
101
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L68">EntityManager/QueryOptions.ts:68</a></li></ul></aside></section>
102
+ <section class="tsd-panel tsd-member">
103
+ <h3 class="tsd-anchor-link" id="shardquerymap"><span>shard<wbr/>Query<wbr/>Map</span><a href="#shardquerymap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
104
+ <div class="tsd-signature"><span class="tsd-kind-property">shardQueryMap</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.ShardQueryMap.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryMap</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cf">CF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span></div>
105
+ <div class="tsd-comment tsd-typography"><p>Each key in this object is a valid entity index token. Each value is a valid
106
+ <a href="../types/index.ShardQueryFunction.html" class="tsd-kind-type-alias">'ShardQueryFunction'</a> that specifies the query of a single page of data on a
107
+ single shard for the mapped index.</p>
108
+ <p>This allows simultaneous queries on multiple sort keys to share a single
109
+ page key, e.g. to match the same string against <code>firstName</code> and <code>lastName</code>
110
+ properties without performing a table scan for either.</p>
111
+ </div><aside class="tsd-sources">
112
+ <ul>
113
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L79">EntityManager/QueryOptions.ts:79</a></li></ul></aside></section>
114
+ <section class="tsd-panel tsd-member">
115
+ <h3 class="tsd-anchor-link" id="sortorder"><code class="tsd-tag">Optional</code><span>sort<wbr/>Order</span><a href="#sortorder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
116
+ <div class="tsd-signature"><span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">?:</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.SortOrder.html" class="tsd-signature-type external" target="_blank">SortOrder</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/index.EntityItemPartial.html" class="tsd-signature-type tsd-kind-type-alias">EntityItemPartial</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
117
+ <div class="tsd-comment tsd-typography"><p>A <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.SortOrder.html"><code>SortOrder</code></a> object specifying the sort order of the result set. Defaults to <code>[]</code>. Aligned with the projected item shape when K is provided.</p>
118
+ </div><aside class="tsd-sources">
119
+ <ul>
120
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L84">EntityManager/QueryOptions.ts:84</a></li></ul></aside></section>
121
+ <section class="tsd-panel tsd-member">
122
+ <h3 class="tsd-anchor-link" id="throttle"><code class="tsd-tag">Optional</code><span>throttle</span><a href="#throttle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
123
+ <div class="tsd-signature"><span class="tsd-kind-property">throttle</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
124
+ <div class="tsd-comment tsd-typography"><p>The maximum number of shards to query in parallel. Overrides options <code>throttle</code>.</p>
125
+ </div>
126
+ <div class="tsd-comment tsd-typography">
127
+ <div class="tsd-tag-defaultValue">
128
+ <h4 class="tsd-anchor-link" id="default-value">Default Value<a href="#default-value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>options.throttle</code></p>
129
+ </div></div><aside class="tsd-sources">
130
+ <ul>
131
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L113">EntityManager/QueryOptions.ts:113</a></li></ul></aside></section>
132
+ <section class="tsd-panel tsd-member">
133
+ <h3 class="tsd-anchor-link" id="timestampfrom"><code class="tsd-tag">Optional</code><span>timestamp<wbr/>From</span><a href="#timestampfrom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
134
+ <div class="tsd-signature"><span class="tsd-kind-property">timestampFrom</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
135
+ <div class="tsd-comment tsd-typography"><p>Lower limit to query shard space.</p>
136
+ <p>Only valid if the query is constrained along the dimension used by the
137
+ <a href="../types/index.Config.html" class="tsd-kind-type-alias"><code>EntityManager.config.entities.&lt;entityToken&gt;.sharding.timestamptokens.timestamp</code></a>
138
+ function to generate <code>shardKey</code>.</p>
139
+ </div>
140
+ <div class="tsd-comment tsd-typography">
141
+ <div class="tsd-tag-defaultValue">
142
+ <h4 class="tsd-anchor-link" id="default-value-1">Default Value<a href="#default-value-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>0</code></p>
143
+ </div></div><aside class="tsd-sources">
144
+ <ul>
145
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L95">EntityManager/QueryOptions.ts:95</a></li></ul></aside></section>
146
+ <section class="tsd-panel tsd-member">
147
+ <h3 class="tsd-anchor-link" id="timestampto"><code class="tsd-tag">Optional</code><span>timestamp<wbr/>To</span><a href="#timestampto" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
148
+ <div class="tsd-signature"><span class="tsd-kind-property">timestampTo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
149
+ <div class="tsd-comment tsd-typography"><p>Upper limit to query shard space.</p>
150
+ <p>Only valid if the query is constrained along the dimension used by the
151
+ <a href="../types/index.Config.html" class="tsd-kind-type-alias"><code>EntityManager.config.entities.&lt;entityToken&gt;.sharding.timestamptokens.timestamp</code></a>
152
+ function to generate <code>shardKey</code>.</p>
153
+ </div>
154
+ <div class="tsd-comment tsd-typography">
155
+ <div class="tsd-tag-defaultValue">
156
+ <h4 class="tsd-anchor-link" id="default-value-2">Default Value<a href="#default-value-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>Date.now()</code></p>
157
+ </div></div><aside class="tsd-sources">
158
+ <ul>
159
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryOptions.ts#L106">EntityManager/QueryOptions.ts:106</a></li></ul></aside></section></section></details></div>
160
+ <div class="col-sidebar">
161
+ <div class="page-menu">
162
+ <div class="tsd-navigation settings">
163
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
164
+ <h3>Settings</h3></summary>
165
+ <div class="tsd-accordion-details">
166
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
167
+ <ul id="tsd-filter-options">
168
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li></ul></div>
169
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
170
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
171
+ <h3>On This Page</h3></summary>
172
+ <div class="tsd-accordion-details">
173
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
174
+ <div><a href="#entitytoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Token</span></a><a href="#item"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>item</span></a><a href="#limit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>limit</span></a><a href="#pagekeymap"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Key<wbr/>Map</span></a><a href="#pagesize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Size</span></a><a href="#shardquerymap"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shard<wbr/>Query<wbr/>Map</span></a><a href="#sortorder"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Order</span></a><a href="#throttle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>throttle</span></a><a href="#timestampfrom"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp<wbr/>From</span></a><a href="#timestampto"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp<wbr/>To</span></a></div></details></div></details></div>
175
+ <div class="site-menu">
176
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
177
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
178
+ <li>Loading...</li></ul></nav></div></div></div><footer>
179
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
180
+ <div class="overlay"></div></body></html>
package/docs/interfaces/index.QueryResult.html ADDED
@@ -0,0 +1,91 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryResult | @karmaniverous/entity-manager</title><meta name="description" content="Documentation for @karmaniverous/entity-manager"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="https://github.com/karmaniverous/entity-manager" class="title">@karmaniverous/entity-manager</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/index.html">index</a></li>
12
+ <li><a href="" aria-current="page">QueryResult</a></li></ul>
13
+ <h1>Interface QueryResult&lt;CC, ET, ITS, K&gt;<code class="tsd-tag">Protected</code></h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>A result returned by a query across multiple shards, where each shard may receive multiple page queries via a dynamically-generated <a href="../types/index.ShardQueryFunction.html" class="tsd-kind-type-alias"><code>ShardQueryFunction</code></a>.</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">QueryResult</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a> <span class="tsd-signature-keyword">extends</span> <a href="index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#count">count</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#items">items</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.EntityItemPartial.html" class="tsd-signature-type tsd-kind-type-alias">EntityItemPartial</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pagekeymap">pageKeyMap</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
18
+ <section class="tsd-panel">
19
+ <h4>Type Parameters</h4>
20
+ <ul class="tsd-type-parameter-list">
21
+ <li><span id="cc"><span class="tsd-kind-type-parameter">CC</span> <span class="tsd-signature-keyword">extends</span> <a href="index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a></span>
22
+ <div class="tsd-comment tsd-typography"><p><a href="../types/index.ConfigMap.html" class="tsd-kind-type-alias"><code>ConfigMap</code></a>.</p>
23
+ </div></li>
24
+ <li><span id="et"><span class="tsd-kind-type-parameter">ET</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/index.EntityToken.html" class="tsd-signature-type tsd-kind-type-alias">EntityToken</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">&gt;</span></span>
25
+ <div class="tsd-comment tsd-typography"><p>Entity token narrowing the result item type.</p>
26
+ </div></li>
27
+ <li><span id="its"><span class="tsd-kind-type-parameter">ITS</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span></span>
28
+ <div class="tsd-comment tsd-typography"><p>Index token subset (carried for symmetry; not represented in the shape).</p>
29
+ </div></li>
30
+ <li><span id="k"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span>
31
+ <div class="tsd-comment tsd-typography"><p>Optional projection keys; narrows item shape when provided.</p>
32
+ </div></li></ul></section><aside class="tsd-sources">
33
+ <ul>
34
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryResult.ts#L20">EntityManager/QueryResult.ts:20</a></li></ul></aside>
35
+ <section class="tsd-panel-group tsd-index-group">
36
+ <section class="tsd-panel tsd-index-panel">
37
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
38
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
39
+ <div class="tsd-accordion-details">
40
+ <section class="tsd-index-section">
41
+ <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
42
+ <div class="tsd-index-list"><a href="#count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a>
43
+ <a href="#items" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>items</span></a>
44
+ <a href="#pagekeymap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Key<wbr/>Map</span></a>
45
+ </div></section></div></details></section></section>
46
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
47
+ <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
48
+ <section>
49
+ <section class="tsd-panel tsd-member">
50
+ <h3 class="tsd-anchor-link" id="count"><span>count</span><a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
51
+ <div class="tsd-signature"><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
52
+ <div class="tsd-comment tsd-typography"><p>Total number of records returned across all shards.</p>
53
+ </div><aside class="tsd-sources">
54
+ <ul>
55
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryResult.ts#L27">EntityManager/QueryResult.ts:27</a></li></ul></aside></section>
56
+ <section class="tsd-panel tsd-member">
57
+ <h3 class="tsd-anchor-link" id="items"><span>items</span><a href="#items" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
58
+ <div class="tsd-signature"><span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.EntityItemPartial.html" class="tsd-signature-type tsd-kind-type-alias">EntityItemPartial</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#et">ET</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
59
+ <div class="tsd-comment tsd-typography"><p>The returned records.</p>
60
+ </div><aside class="tsd-sources">
61
+ <ul>
62
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryResult.ts#L30">EntityManager/QueryResult.ts:30</a></li></ul></aside></section>
63
+ <section class="tsd-panel tsd-member">
64
+ <h3 class="tsd-anchor-link" id="pagekeymap"><span>page<wbr/>Key<wbr/>Map</span><a href="#pagekeymap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
65
+ <div class="tsd-signature"><span class="tsd-kind-property">pageKeyMap</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
66
+ <div class="tsd-comment tsd-typography"><p>A compressed, two-layer map of page keys, used to query the next page of
67
+ data for a given sort key on each shard of a given hash key.</p>
68
+ </div><aside class="tsd-sources">
69
+ <ul>
70
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/QueryResult.ts#L36">EntityManager/QueryResult.ts:36</a></li></ul></aside></section></section></details></div>
71
+ <div class="col-sidebar">
72
+ <div class="page-menu">
73
+ <div class="tsd-navigation settings">
74
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
75
+ <h3>Settings</h3></summary>
76
+ <div class="tsd-accordion-details">
77
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
78
+ <ul id="tsd-filter-options">
79
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li></ul></div>
80
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
81
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
82
+ <h3>On This Page</h3></summary>
83
+ <div class="tsd-accordion-details">
84
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
85
+ <div><a href="#count"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a><a href="#items"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>items</span></a><a href="#pagekeymap"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Key<wbr/>Map</span></a></div></details></div></details></div>
86
+ <div class="site-menu">
87
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
88
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
89
+ <li>Loading...</li></ul></nav></div></div></div><footer>
90
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
91
+ <div class="overlay"></div></body></html>
package/docs/interfaces/index.ShardBump.html ADDED
@@ -0,0 +1,79 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ShardBump | @karmaniverous/entity-manager</title><meta name="description" content="Documentation for @karmaniverous/entity-manager"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="https://github.com/karmaniverous/entity-manager" class="title">@karmaniverous/entity-manager</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/index.html">index</a></li>
12
+ <li><a href="" aria-current="page">ShardBump</a></li></ul>
13
+ <h1>Interface ShardBump<code class="tsd-tag">Protected</code></h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>Defines a single time period in an entity sharding strategy.</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ShardBump</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#charbits">charBits</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#chars">chars</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#timestamp">timestamp</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
18
+ <ul>
19
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardBump.ts#L7">EntityManager/ShardBump.ts:7</a></li></ul></aside>
20
+ <section class="tsd-panel-group tsd-index-group">
21
+ <section class="tsd-panel tsd-index-panel">
22
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
23
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
24
+ <div class="tsd-accordion-details">
25
+ <section class="tsd-index-section">
26
+ <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
27
+ <div class="tsd-index-list"><a href="#charbits" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>char<wbr/>Bits</span></a>
28
+ <a href="#chars" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>chars</span></a>
29
+ <a href="#timestamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp</span></a>
30
+ </div></section></div></details></section></section>
31
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
32
+ <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
33
+ <section>
34
+ <section class="tsd-panel tsd-member">
35
+ <h3 class="tsd-anchor-link" id="charbits"><span>char<wbr/>Bits</span><a href="#charbits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
36
+ <div class="tsd-signature"><span class="tsd-kind-property">charBits</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
37
+ <div class="tsd-comment tsd-typography"><p>The number of bits per character in the bump's shard space. For example, <code>0</code> yields a single shard per character, and a value of <code>2</code> would yield 4 shards per character.</p>
38
+ <p>This value must be an integer between <code>1</code> and <code>5</code> inclusive.</p>
39
+ </div><aside class="tsd-sources">
40
+ <ul>
41
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardBump.ts#L20">EntityManager/ShardBump.ts:20</a></li></ul></aside></section>
42
+ <section class="tsd-panel tsd-member">
43
+ <h3 class="tsd-anchor-link" id="chars"><span>chars</span><a href="#chars" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
44
+ <div class="tsd-signature"><span class="tsd-kind-property">chars</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
45
+ <div class="tsd-comment tsd-typography"><p>The number of characters used to represent the bump's shard key.</p>
46
+ <p>This value must be an integer between <code>0</code> and <code>40</code> inclusive. Note that more than a few characters will result in an impossibly large shard space! *
47
+ A ShardBump with <code>chars</code> of <code>2</code> and <code>charBits</code> of <code>3</code> would yield a two-character shard key with a space of 16 shards.</p>
48
+ </div><aside class="tsd-sources">
49
+ <ul>
50
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardBump.ts#L28">EntityManager/ShardBump.ts:28</a></li></ul></aside></section>
51
+ <section class="tsd-panel tsd-member">
52
+ <h3 class="tsd-anchor-link" id="timestamp"><span>timestamp</span><a href="#timestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
53
+ <div class="tsd-signature"><span class="tsd-kind-property">timestamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
54
+ <div class="tsd-comment tsd-typography"><p>The timestamp marking the beginning of the time period. Must be a non-negative integer.</p>
55
+ <p>This value must be unique across all <a href="#" class="tsd-kind-interface"><code>ShardBumps</code></a> for the entity.</p>
56
+ </div><aside class="tsd-sources">
57
+ <ul>
58
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ShardBump.ts#L13">EntityManager/ShardBump.ts:13</a></li></ul></aside></section></section></details></div>
59
+ <div class="col-sidebar">
60
+ <div class="page-menu">
61
+ <div class="tsd-navigation settings">
62
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
63
+ <h3>Settings</h3></summary>
64
+ <div class="tsd-accordion-details">
65
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
66
+ <ul id="tsd-filter-options">
67
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li></ul></div>
68
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
69
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
70
+ <h3>On This Page</h3></summary>
71
+ <div class="tsd-accordion-details">
72
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
73
+ <div><a href="#charbits"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>char<wbr/>Bits</span></a><a href="#chars"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>chars</span></a><a href="#timestamp"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp</span></a></div></details></div></details></div>
74
+ <div class="site-menu">
75
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
76
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
77
+ <li>Loading...</li></ul></nav></div></div></div><footer>
78
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
79
+ <div class="overlay"></div></body></html>