npm - @karmaniverous/entity-manager - Versions diffs - 5.0.8 → 5.0.10 - Mend

@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

package/.github/FUNDING.yml +3 -0
package/README.md +1 -2
package/dist/cjs/BaseEntityClient/BaseEntityClient.js +28 -0
package/dist/cjs/BaseQueryBuilder/BaseQueryBuilder.js +62 -0
package/dist/cjs/EntityManager/EntityManager.js +131 -0
package/dist/cjs/EntityManager/ParsedConfig.js +385 -0
package/dist/cjs/EntityManager/addKeys.js +60 -0
package/dist/cjs/EntityManager/createEntityManager.js +46 -0
package/dist/cjs/EntityManager/decodeElement.js +46 -0
package/dist/cjs/EntityManager/decodeGeneratedProperty.js +53 -0
package/dist/cjs/EntityManager/dehydrateIndexItem.js +68 -0
package/dist/cjs/EntityManager/dehydratePageKeyMap.js +93 -0
package/dist/cjs/EntityManager/encodeElement.js +40 -0
package/dist/cjs/EntityManager/encodeGeneratedProperty.js +55 -0
package/dist/cjs/EntityManager/findIndexToken.js +10 -0
package/dist/cjs/EntityManager/getHashKeySpace.js +89 -0
package/dist/cjs/EntityManager/getIndexComponents.js +23 -0
package/dist/cjs/EntityManager/getPrimaryKey.js +76 -0
package/dist/cjs/EntityManager/getShardBump.js +24 -0
package/dist/cjs/EntityManager/query.js +130 -0
package/dist/cjs/EntityManager/rehydrateIndexItem.js +65 -0
package/dist/cjs/EntityManager/rehydratePageKeyMap.js +103 -0
package/dist/cjs/EntityManager/removeKeys.js +51 -0
package/dist/cjs/EntityManager/unwrapIndex.js +59 -0
package/dist/cjs/EntityManager/updateItemHashKey.js +79 -0
package/dist/cjs/EntityManager/updateItemRangeKey.js +65 -0
package/dist/cjs/EntityManager/validateEntityToken.js +17 -0
package/dist/cjs/EntityManager/validateGeneratedProperty.js +23 -0
package/dist/cjs/EntityManager/validateIndexToken.js +16 -0
package/dist/cjs/EntityManager/validateTranscodedProperty.js +16 -0
package/dist/cjs/index.js +15 -0
package/dist/default/lib/EntityManager/EntityManager.js +46 -69
package/dist/default/lib/EntityManager/PrivateEntityManager.js +44 -51
package/dist/index.d.ts +1163 -0
package/dist/mjs/BaseEntityClient/BaseEntityClient.js +26 -0
package/dist/mjs/BaseQueryBuilder/BaseQueryBuilder.js +60 -0
package/dist/mjs/EntityManager/EntityManager.js +129 -0
package/dist/mjs/EntityManager/ParsedConfig.js +383 -0
package/dist/mjs/EntityManager/addKeys.js +58 -0
package/dist/mjs/EntityManager/createEntityManager.js +44 -0
package/dist/mjs/EntityManager/decodeElement.js +44 -0
package/dist/mjs/EntityManager/decodeGeneratedProperty.js +51 -0
package/dist/mjs/EntityManager/dehydrateIndexItem.js +66 -0
package/dist/mjs/EntityManager/dehydratePageKeyMap.js +91 -0
package/dist/mjs/EntityManager/encodeElement.js +38 -0
package/dist/mjs/EntityManager/encodeGeneratedProperty.js +53 -0
package/dist/mjs/EntityManager/findIndexToken.js +8 -0
package/dist/mjs/EntityManager/getHashKeySpace.js +87 -0
package/dist/mjs/EntityManager/getIndexComponents.js +21 -0
package/dist/mjs/EntityManager/getPrimaryKey.js +74 -0
package/dist/mjs/EntityManager/getShardBump.js +22 -0
package/dist/mjs/EntityManager/query.js +128 -0
package/dist/mjs/EntityManager/rehydrateIndexItem.js +63 -0
package/dist/mjs/EntityManager/rehydratePageKeyMap.js +101 -0
package/dist/mjs/EntityManager/removeKeys.js +49 -0
package/dist/mjs/EntityManager/unwrapIndex.js +57 -0
package/dist/mjs/EntityManager/updateItemHashKey.js +77 -0
package/dist/mjs/EntityManager/updateItemRangeKey.js +63 -0
package/dist/mjs/EntityManager/validateEntityToken.js +15 -0
package/dist/mjs/EntityManager/validateGeneratedProperty.js +21 -0
package/dist/mjs/EntityManager/validateIndexToken.js +14 -0
package/dist/mjs/EntityManager/validateTranscodedProperty.js +14 -0
package/dist/mjs/index.js +5 -0
package/docs/.nojekyll +1 -0
package/docs/assets/hierarchy.js +1 -0
package/docs/assets/highlight.css +99 -0
package/docs/assets/icons.js +18 -0
package/docs/assets/icons.svg +1 -0
package/docs/assets/main.js +60 -0
package/docs/assets/navigation.js +1 -0
package/docs/assets/search.js +1 -0
package/docs/assets/style.css +1648 -0
package/docs/classes/index.BaseEntityClient.html +124 -0
package/docs/classes/index.BaseQueryBuilder.html +229 -0
package/docs/classes/index.EntityManager.html +510 -0
package/docs/documents/CHANGELOG.html +1432 -0
package/docs/documents/guides_stan-assistant-guide.html +431 -0
package/docs/functions/index.createEntityManager.html +60 -0
package/docs/hierarchy.html +31 -0
package/docs/index.html +212 -0
package/docs/interfaces/index.BaseConfigMap.html +113 -0
package/docs/interfaces/index.BaseEntityClientOptions.html +82 -0
package/docs/interfaces/index.BaseQueryBuilderOptions.html +92 -0
package/docs/interfaces/index.CapturedConfigMapFrom.html +126 -0
package/docs/interfaces/index.ConfigInput.html +189 -0
package/docs/interfaces/index.ParsedConfig.html +144 -0
package/docs/interfaces/index.ParsedEntityConfig.html +91 -0
package/docs/interfaces/index.ParsedGeneratedPropertiesConfig.html +67 -0
package/docs/interfaces/index.ParsedIndexConfig.html +79 -0
package/docs/interfaces/index.ParsedTranscoder.html +71 -0
package/docs/interfaces/index.QueryOptions.html +180 -0
package/docs/interfaces/index.QueryResult.html +91 -0
package/docs/interfaces/index.ShardBump.html +79 -0
package/docs/interfaces/index.ShardQueryResult.html +93 -0
package/docs/modules/index.html +47 -0
package/docs/modules.html +38 -0
package/docs/sitemap.xml +263 -0
package/docs/types/index.BaseKeyTokens.html +39 -0
package/docs/types/index.Config.html +75 -0
package/docs/types/index.ConfigMap.html +41 -0
package/docs/types/index.ConfigOfClient.html +45 -0
package/docs/types/index.EntitiesFromSchema.html +39 -0
package/docs/types/index.EntityClientItemByToken.html +45 -0
package/docs/types/index.EntityClientRecordByToken.html +43 -0
package/docs/types/index.EntityItem.html +41 -0
package/docs/types/index.EntityItemPartial.html +44 -0
package/docs/types/index.EntityKey.html +40 -0
package/docs/types/index.EntityOfToken.html +39 -0
package/docs/types/index.EntityRecord.html +39 -0
package/docs/types/index.EntityRecordPartial.html +40 -0
package/docs/types/index.EntityToken.html +40 -0
package/docs/types/index.FallbackIndexTokenSet.html +40 -0
package/docs/types/index.HasIndexFor.html +43 -0
package/docs/types/index.HashKeyFrom.html +38 -0
package/docs/types/index.IndexComponentTokens.html +45 -0
package/docs/types/index.IndexHashKeyOf.html +42 -0
package/docs/types/index.IndexRangeKeyOf.html +41 -0
package/docs/types/index.IndexTokensFrom.html +41 -0
package/docs/types/index.IndexTokensOf.html +40 -0
package/docs/types/index.KeysFrom.html +38 -0
package/docs/types/index.PageKey.html +40 -0
package/docs/types/index.PageKeyByIndex.html +46 -0
package/docs/types/index.PresentIndexTokenSet.html +45 -0
package/docs/types/index.Projected.html +39 -0
package/docs/types/index.QueryBuilderQueryOptions.html +45 -0
package/docs/types/index.QueryOptionsByCC.html +49 -0
package/docs/types/index.QueryOptionsByCF.html +47 -0
package/docs/types/index.RangeKeyFrom.html +38 -0
package/docs/types/index.ShardQueryFunction.html +63 -0
package/docs/types/index.ShardQueryMap.html +56 -0
package/docs/types/index.ShardQueryMapByCC.html +49 -0
package/docs/types/index.ShardQueryMapByCF.html +47 -0
package/docs/types/index.ShardedKeysFrom.html +38 -0
package/docs/types/index.StorageItem.html +42 -0
package/docs/types/index.StorageRecord.html +40 -0
package/docs/types/index.TranscodedPropertiesFrom.html +38 -0
package/docs/types/index.UnshardedKeysFrom.html +38 -0
package/docs/types/index.ValidateConfigMap.html +40 -0
package/lib/EntityManager/PrivateEntityManager.js +4 -0
package/package.json +6 -6

package/docs/classes/index.BaseEntityClient.html ADDED Viewed

@@ -0,0 +1,124 @@
+<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseEntityClient | @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">
+<div class="tsd-toolbar-contents container"><a href="https://github.com/karmaniverous/entity-manager" class="title">@karmaniverous/entity-manager</a>
+<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"/>
+<ul role="listbox" id="tsd-search-results"></ul>
+<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
+<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>
+<div class="container container-main">
+<div class="col-content">
+<div class="tsd-page-title">
+<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
+<li><a href="../modules/index.html">index</a></li>
+<li><a href="" aria-current="page">BaseEntityClient</a></li></ul>
+<h1>Class BaseEntityClient&lt;CC, CF&gt;<code class="tsd-tag">Abstract</code></h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Base EntityClient class. Integrates <a href="index.EntityManager.html" class="tsd-kind-class"><code>EntityManager</code></a> with injected logging &amp; enhanced batch processing.</p>
+</div></section>
+<section class="tsd-panel">
+<h4>Type Parameters</h4>
+<ul class="tsd-type-parameter-list">
+<li><span id="cc"><span class="tsd-kind-type-parameter">CC</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a></span>
+<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="../interfaces/index.BaseConfigMap.html" class="tsd-kind-interface"><code>BaseConfigMap</code></a>.</p>
+</div></li>
+<li><span id="cf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span>
+<div class="tsd-comment tsd-typography"><p>Values-first config literal type captured by the manager (phantom; type-only). Propagated so
+client-facing calls that return <code>IndexTokensOf&lt;CF&gt;</code> retain the narrowed union.</p>
+</div></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClient.ts#L19">BaseEntityClient/BaseEntityClient.ts:19</a></li></ul></aside>
+<section class="tsd-panel-group tsd-index-group">
+<section class="tsd-panel tsd-index-panel">
+<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>
+<h5 class="tsd-index-heading uppercase">Index</h5></summary>
+<div class="tsd-accordion-details">
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" 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>
+<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section>
+<section class="tsd-index-section">
+<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>
+<div class="tsd-index-list"><a href="#batchprocessoptions" 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>batch<wbr/>Process<wbr/>Options</span></a>
+<a href="#entitymanager" 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/>Manager</span></a>
+<a href="#logger" 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>logger</span></a>
+</div></section></div></details></section></section>
+<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
+<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-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>
+<section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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>
+<ul class="tsd-signatures">
+<li class="">
+<div class="tsd-signature tsd-anchor-link" id="constructorbaseentityclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">BaseEntityClient</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorbaseentityclientcc">CC</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorbaseentityclientcf">CF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/index.BaseEntityClientOptions.html" class="tsd-signature-type tsd-kind-interface">BaseEntityClientOptions</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">BaseEntityClient</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructorbaseentityclient" 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></div>
+<div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Base EntityClient constructor.</p>
+</div>
+<section class="tsd-panel">
+<h4>Type Parameters</h4>
+<ul class="tsd-type-parameter-list">
+<li><span id="constructorbaseentityclientcc"><span class="tsd-kind-type-parameter">CC</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a></span>
+<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="../interfaces/index.BaseConfigMap.html" class="tsd-kind-interface"><code>BaseConfigMap</code></a>.</p>
+</div></li>
+<li><span id="constructorbaseentityclientcf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span>
+<div class="tsd-comment tsd-typography"><p>Values-first config literal type captured by the manager (phantom; type-only). Propagated so
+client-facing calls that return <code>IndexTokensOf&lt;CF&gt;</code> retain the narrowed union.</p>
+</div></li></ul></section>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/index.BaseEntityClientOptions.html" class="tsd-signature-type tsd-kind-interface">BaseEntityClientOptions</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span></span>
+<div class="tsd-comment tsd-typography"><p><a href="../interfaces/index.BaseEntityClientOptions.html" class="tsd-kind-interface"><code>BaseEntityClientOptions</code></a> object.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">BaseEntityClient</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClient.ts#L36">BaseEntityClient/BaseEntityClient.ts:36</a></li></ul></aside></div></li></ul></section></section></details>
+<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>
+<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>
+<section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="batchprocessoptions"><code class="tsd-tag">Readonly</code><span>batch<wbr/>Process<wbr/>Options</span><a href="#batchprocessoptions" 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>
+<div class="tsd-signature"><span class="tsd-kind-property">batchProcessOptions</span><span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype" class="tsd-signature-type external" target="_blank">NonNullable</a><span class="tsd-signature-symbol">&lt;</span><br/>    <a href="../interfaces/index.BaseEntityClientOptions.html" class="tsd-signature-type tsd-kind-interface">BaseEntityClientOptions</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><a href="../interfaces/index.BaseEntityClientOptions.html#batchprocessoptions"><span class="tsd-signature-type">&quot;batchProcessOptions&quot;</span></a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></div>
+<div class="tsd-comment tsd-typography"><p>Default batch process options.</p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClient.ts#L21">BaseEntityClient/BaseEntityClient.ts:21</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="entitymanager"><code class="tsd-tag">Readonly</code><span>entity<wbr/>Manager</span><a href="#entitymanager" 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>
+<div class="tsd-signature"><span class="tsd-kind-property">entityManager</span><span class="tsd-signature-symbol">:</span> <a href="index.EntityManager.html" class="tsd-signature-type tsd-kind-class">EntityManager</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span></div>
+<div class="tsd-comment tsd-typography"><p><a href="index.EntityManager.html" class="tsd-kind-class"><code>EntityManager</code></a> instance.</p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClient.ts#L26">BaseEntityClient/BaseEntityClient.ts:26</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="logger"><code class="tsd-tag">Readonly</code><span>logger</span><a href="#logger" 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>
+<div class="tsd-signature"><span class="tsd-kind-property">logger</span><span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype" class="tsd-signature-type external" target="_blank">NonNullable</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/index.BaseEntityClientOptions.html" class="tsd-signature-type tsd-kind-interface">BaseEntityClientOptions</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><a href="../interfaces/index.BaseEntityClientOptions.html#logger"><span class="tsd-signature-type">&quot;logger&quot;</span></a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></div>
+<div class="tsd-comment tsd-typography"><p>Injected logger object. Must support <code>debug</code> and <code>error</code> methods. Default: <code>console</code></p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClient.ts#L29">BaseEntityClient/BaseEntityClient.ts:29</a></li></ul></aside></section></section></details></div>
+<div class="col-sidebar">
+<div class="page-menu">
+<div class="tsd-navigation settings">
+<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>
+<h3>Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
+<ul id="tsd-filter-options">
+<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>
+<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>
+<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>
+<h3>On This Page</h3></summary>
+<div class="tsd-accordion-details">
+<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
+<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
+<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>
+<div><a href="#batchprocessoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>batch<wbr/>Process<wbr/>Options</span></a><a href="#entitymanager"><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/>Manager</span></a><a href="#logger"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a></div></details></div></details></div>
+<div class="site-menu">
+<nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
+<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
+<li>Loading...</li></ul></nav></div></div></div><footer>
+<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
+<div class="overlay"></div></body></html>

package/docs/classes/index.BaseQueryBuilder.html ADDED Viewed

@@ -0,0 +1,229 @@
+<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseQueryBuilder | @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">
+<div class="tsd-toolbar-contents container"><a href="https://github.com/karmaniverous/entity-manager" class="title">@karmaniverous/entity-manager</a>
+<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"/>
+<ul role="listbox" id="tsd-search-results"></ul>
+<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
+<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>
+<div class="container container-main">
+<div class="col-content">
+<div class="tsd-page-title">
+<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
+<li><a href="../modules/index.html">index</a></li>
+<li><a href="" aria-current="page">BaseQueryBuilder</a></li></ul>
+<h1>Class BaseQueryBuilder&lt;CC, EntityClient, IndexParams, ET, ITS, CF, K&gt;<code class="tsd-tag">Abstract</code></h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Abstract base class supporting a fluent API for building a <a href="../types/index.ShardQueryMap.html" class="tsd-kind-type-alias"><code>ShardQueryMap</code></a> using a database client.</p>
+</div></section>
+<section class="tsd-panel">
+<h4>Type Parameters</h4>
+<ul class="tsd-type-parameter-list">
+<li><span id="cc"><span class="tsd-kind-type-parameter">CC</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a></span>
+<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="../interfaces/index.BaseConfigMap.html" class="tsd-kind-interface"><code>BaseConfigMap</code></a>.</p>
+</div></li>
+<li><span id="entityclient"><span class="tsd-kind-type-parameter">EntityClient</span> <span class="tsd-signature-keyword">extends</span> <a href="index.BaseEntityClient.html" class="tsd-signature-type tsd-kind-class">BaseEntityClient</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>
+<div class="tsd-comment tsd-typography"><p><a href="index.BaseEntityClient.html" class="tsd-kind-class"><code>BaseEntityClient</code></a> derived class instance.</p>
+</div></li>
+<li><span id="indexparams"><span class="tsd-kind-type-parameter">IndexParams</span></span>
+<div class="tsd-comment tsd-typography"><p>Database platform-specific, index-specific query parameters.</p>
+</div></li>
+<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></li>
+<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></li>
+<li><span id="cf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span>
+<div class="tsd-comment tsd-typography"><p>Optional values-first config literal type for page key narrowing.</p>
+</div></li>
+<li><span id="k"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span>
+<div class="tsd-comment tsd-typography"><p>Optional projection keys; narrows item shape when provided.</p>
+</div></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L27">BaseQueryBuilder/BaseQueryBuilder.ts:27</a></li></ul></aside>
+<section class="tsd-panel-group tsd-index-group">
+<section class="tsd-panel tsd-index-panel">
+<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>
+<h5 class="tsd-index-heading uppercase">Index</h5></summary>
+<div class="tsd-accordion-details">
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" 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>
+<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section>
+<section class="tsd-index-section">
+<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>
+<div class="tsd-index-list"><a href="#entityclient-1" 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/>Client</span></a>
+<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>
+<a href="#hashkeytoken" 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>hash<wbr/>Key<wbr/>Token</span></a>
+<a href="#indexparamsmap" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index<wbr/>Params<wbr/>Map</span></a>
+<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>
+</div></section>
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" 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>
+<div class="tsd-index-list"><a href="#build" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a>
+<a href="#getshardqueryfunction" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Shard<wbr/>Query<wbr/>Function</span></a>
+<a href="#query" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query</span></a>
+</div></section></div></details></section></section>
+<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
+<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-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>
+<section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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>
+<ul class="tsd-signatures">
+<li class="">
+<div class="tsd-signature tsd-anchor-link" id="constructorbasequerybuilder"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">BaseQueryBuilder</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorbasequerybuildercc">CC</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/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="#constructorbasequerybuilderentityclient">EntityClient</a> <span class="tsd-signature-keyword">extends</span> <a href="index.BaseEntityClient.html" class="tsd-signature-type tsd-kind-class">BaseEntityClient</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> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorbasequerybuilderindexparams">IndexParams</a><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorbasequerybuilderet">ET</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">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</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="#constructorbasequerybuilderits">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="#constructorbasequerybuildercf">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="#constructorbasequerybuilderk">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/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/index.BaseQueryBuilderOptions.html" class="tsd-signature-type tsd-kind-interface">BaseQueryBuilderOptions</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="#entityclient">EntityClient</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">BaseQueryBuilder</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="#entityclient">EntityClient</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#indexparams">IndexParams</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><a href="#constructorbasequerybuilder" 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></div>
+<div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>BaseQueryBuilder constructor.</p>
+</div>
+<section class="tsd-panel">
+<h4>Type Parameters</h4>
+<ul class="tsd-type-parameter-list">
+<li><span id="constructorbasequerybuildercc"><span class="tsd-kind-type-parameter">CC</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a></span>
+<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="../interfaces/index.BaseConfigMap.html" class="tsd-kind-interface"><code>BaseConfigMap</code></a>.</p>
+</div></li>
+<li><span id="constructorbasequerybuilderentityclient"><span class="tsd-kind-type-parameter">EntityClient</span> <span class="tsd-signature-keyword">extends</span> <a href="index.BaseEntityClient.html" class="tsd-signature-type tsd-kind-class">BaseEntityClient</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> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span>
+<div class="tsd-comment tsd-typography"><p><a href="index.BaseEntityClient.html" class="tsd-kind-class"><code>BaseEntityClient</code></a> derived class instance.</p>
+</div></li>
+<li><span id="constructorbasequerybuilderindexparams"><span class="tsd-kind-type-parameter">IndexParams</span></span>
+<div class="tsd-comment tsd-typography"><p>Database platform-specific, index-specific query parameters.</p>
+</div></li>
+<li><span id="constructorbasequerybuilderet"><span class="tsd-kind-type-parameter">ET</span> <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">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">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></li>
+<li><span id="constructorbasequerybuilderits"><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></li>
+<li><span id="constructorbasequerybuildercf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span>
+<div class="tsd-comment tsd-typography"><p>Optional values-first config literal type for page key narrowing.</p>
+</div></li>
+<li><span id="constructorbasequerybuilderk"><span class="tsd-kind-type-parameter">K</span> = <span class="tsd-signature-type">unknown</span></span>
+<div class="tsd-comment tsd-typography"><p>Optional projection keys; narrows item shape when provided.</p>
+</div></li></ul></section>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/index.BaseQueryBuilderOptions.html" class="tsd-signature-type tsd-kind-interface">BaseQueryBuilderOptions</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="#entityclient">EntityClient</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">BaseQueryBuilder</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="#entityclient">EntityClient</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#indexparams">IndexParams</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></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L59">BaseQueryBuilder/BaseQueryBuilder.ts:59</a></li></ul></aside></div></li></ul></section></section></details>
+<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>
+<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>
+<section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="entityclient-1"><code class="tsd-tag">Readonly</code><span>entity<wbr/>Client</span><a href="#entityclient-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></h3>
+<div class="tsd-signature"><span class="tsd-kind-property">entityClient</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#entityclient">EntityClient</a></div>
+<div class="tsd-comment tsd-typography"><p><a href="index.BaseEntityClient.html" class="tsd-kind-class"><code>EntityClient</code></a> instance.</p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L37">BaseQueryBuilder/BaseQueryBuilder.ts:37</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="entitytoken"><code class="tsd-tag">Readonly</code><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>
+<div class="tsd-signature"><span class="tsd-kind-property">entityToken</span><span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union" class="tsd-signature-type external" target="_blank">Extract</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.Exactify.html" class="tsd-signature-type external" target="_blank">Exactify</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><span class="tsd-signature-type">&quot;EntityMap&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
+<div class="tsd-comment tsd-typography"><p>Entity token.</p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L40">BaseQueryBuilder/BaseQueryBuilder.ts:40</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="hashkeytoken"><code class="tsd-tag">Readonly</code><span>hash<wbr/>Key<wbr/>Token</span><a href="#hashkeytoken" 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>
+<div class="tsd-signature"><span class="tsd-kind-property">hashKeyToken</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;HashKey&quot;</span><span class="tsd-signature-symbol">]</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#cc">CC</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;ShardedKeys&quot;</span><span class="tsd-signature-symbol">]</span></div>
+<div class="tsd-comment tsd-typography"><p>Hash key token.</p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L43">BaseQueryBuilder/BaseQueryBuilder.ts:43</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member tsd-is-protected">
+<h3 class="tsd-anchor-link" id="indexparamsmap"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>index<wbr/>Params<wbr/>Map</span><a href="#indexparamsmap" 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>
+<div class="tsd-signature"><span class="tsd-kind-property">indexParamsMap</span><span class="tsd-signature-symbol">:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol">&lt;</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="#indexparams">IndexParams</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
+<div class="tsd-comment tsd-typography"><p>Maps <code>indexToken</code> values to database platform-specific query parameters.</p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L53">BaseQueryBuilder/BaseQueryBuilder.ts:53</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="pagekeymap"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</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>
+<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>
+<div class="tsd-comment tsd-typography"><p>Dehydrated page key map.</p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L46">BaseQueryBuilder/BaseQueryBuilder.ts:46</a></li></ul></aside></section></section></details>
+<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
+<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-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>
+<section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="build"><span>build</span><a href="#build" 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>
+<ul class="tsd-signatures">
+<li class="">
+<div class="tsd-signature tsd-anchor-link" id="build-1"><span class="tsd-kind-call-signature">build</span><span class="tsd-signature-symbol">()</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><a href="#build-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></div>
+<div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Builds a <a href="../types/index.ShardQueryMap.html" class="tsd-kind-type-alias"><code>ShardQueryMap</code></a> object.</p>
+</div>
+<h4 class="tsd-returns-title">Returns <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></h4><ul>
+<li>The <a href="../types/index.ShardQueryMap.html" class="tsd-kind-type-alias"><code>ShardQueryMap</code></a> object.</li>
+</ul>
+<aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L94">BaseQueryBuilder/BaseQueryBuilder.ts:94</a></li></ul></aside></div></li></ul></section>
+<section class="tsd-panel tsd-member tsd-is-protected">
+<h3 class="tsd-anchor-link" id="getshardqueryfunction"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Abstract</code><span>get<wbr/>Shard<wbr/>Query<wbr/>Function</span><a href="#getshardqueryfunction" 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>
+<ul class="tsd-signatures tsd-is-protected">
+<li class="tsd-is-protected">
+<div class="tsd-signature tsd-anchor-link" id="getshardqueryfunction-1"><span class="tsd-kind-call-signature">getShardQueryFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">indexToken</span><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><span class="tsd-signature-symbol">:</span> <a href="../types/index.ShardQueryFunction.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryFunction</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><a href="#getshardqueryfunction-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></div>
+<div class="tsd-description"><code class="tsd-tag">Protected</code>
+<div class="tsd-comment tsd-typography"><p>Build a shard query function for a specific index token.</p>
+</div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li><span><span class="tsd-kind-parameter">indexToken</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#its">ITS</a></span>
+<div class="tsd-comment tsd-typography"><p>Index token identifying which index to query.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="../types/index.ShardQueryFunction.html" class="tsd-signature-type tsd-kind-type-alias">ShardQueryFunction</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></h4><p>A <a href="../types/index.ShardQueryFunction.html" class="tsd-kind-type-alias"><code>ShardQueryFunction</code></a> that queries a single shard for this index.</p>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-remarks">
+<h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" 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>Implementations are provider-specific (e.g., DynamoDB). The returned function must:</p>
+<ul>
+<li>Query exactly one shard (partition) per invocation using the provided hash key value.</li>
+<li>Respect <code>pageKey</code> and <code>pageSize</code> for pagination.</li>
+<li>Return <code>pageKey: undefined</code> when that shard is exhausted.</li>
+</ul>
+<p>Entity Manager will orchestrate calling these functions across shards and indexes.</p>
+</div></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L85">BaseQueryBuilder/BaseQueryBuilder.ts:85</a></li></ul></aside></div></li></ul></section>
+<section class="tsd-panel tsd-member">
+<h3 class="tsd-anchor-link" id="query"><span>query</span><a href="#query" 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>
+<ul class="tsd-signatures">
+<li class="">
+<div class="tsd-signature tsd-anchor-link" id="query-1"><span class="tsd-kind-call-signature">query</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.QueryBuilderQueryOptions.html" class="tsd-signature-type tsd-kind-type-alias">QueryBuilderQueryOptions</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/index.QueryResult.html" class="tsd-signature-type tsd-kind-interface">QueryResult</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="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#query-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></div>
+<div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Execute the built query across shards and indexes via <a href="index.EntityManager.html#query" class="tsd-kind-method"><code>EntityManager.query</code></a>.</p>
+</div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/index.QueryBuilderQueryOptions.html" class="tsd-signature-type tsd-kind-type-alias">QueryBuilderQueryOptions</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="#cf">CF</a><span class="tsd-signature-symbol">&gt;</span></span>
+<div class="tsd-comment tsd-typography"><p>Query options excluding <code>entityToken</code>, <code>pageKeyMap</code>, and <code>shardQueryMap</code>, which are supplied by the builder.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/index.QueryResult.html" class="tsd-signature-type tsd-kind-interface">QueryResult</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="#k">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The merged, de-duplicated, sorted query result, including a compact <code>pageKeyMap</code> token for the next page.</p>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-remarks">
+<h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-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>This delegates orchestration to Entity Manager; provider-specific behavior lives in <a href="#getshardqueryfunction" class="tsd-kind-method"><code>getShardQueryFunction</code></a>.</p>
+</div></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilder.ts#L110">BaseQueryBuilder/BaseQueryBuilder.ts:110</a></li></ul></aside></div></li></ul></section></section></details></div>
+<div class="col-sidebar">
+<div class="page-menu">
+<div class="tsd-navigation settings">
+<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>
+<h3>Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
+<ul id="tsd-filter-options">
+<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>
+<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>
+<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>
+<h3>On This Page</h3></summary>
+<div class="tsd-accordion-details">
+<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
+<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
+<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>
+<div><a href="#entityclient-1"><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/>Client</span></a><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="#hashkeytoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hash<wbr/>Key<wbr/>Token</span></a><a href="#indexparamsmap" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index<wbr/>Params<wbr/>Map</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>
+<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
+<div><a href="#build"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a><a href="#getshardqueryfunction" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Shard<wbr/>Query<wbr/>Function</span></a><a href="#query"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query</span></a></div></details></div></details></div>
+<div class="site-menu">
+<nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
+<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
+<li>Loading...</li></ul></nav></div></div></div><footer>
+<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
+<div class="overlay"></div></body></html>