@karmaniverous/entity-manager 5.0.9 → 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 (139) hide show
  1. package/.github/FUNDING.yml +3 -3
  2. package/dist/cjs/BaseEntityClient/BaseEntityClient.js +28 -0
  3. package/dist/cjs/BaseQueryBuilder/BaseQueryBuilder.js +62 -0
  4. package/dist/cjs/EntityManager/EntityManager.js +131 -0
  5. package/dist/cjs/EntityManager/ParsedConfig.js +385 -0
  6. package/dist/cjs/EntityManager/addKeys.js +60 -0
  7. package/dist/cjs/EntityManager/createEntityManager.js +46 -0
  8. package/dist/cjs/EntityManager/decodeElement.js +46 -0
  9. package/dist/cjs/EntityManager/decodeGeneratedProperty.js +53 -0
  10. package/dist/cjs/EntityManager/dehydrateIndexItem.js +68 -0
  11. package/dist/cjs/EntityManager/dehydratePageKeyMap.js +93 -0
  12. package/dist/cjs/EntityManager/encodeElement.js +40 -0
  13. package/dist/cjs/EntityManager/encodeGeneratedProperty.js +55 -0
  14. package/dist/cjs/EntityManager/findIndexToken.js +10 -0
  15. package/dist/cjs/EntityManager/getHashKeySpace.js +89 -0
  16. package/dist/cjs/EntityManager/getIndexComponents.js +23 -0
  17. package/dist/cjs/EntityManager/getPrimaryKey.js +76 -0
  18. package/dist/cjs/EntityManager/getShardBump.js +24 -0
  19. package/dist/cjs/EntityManager/query.js +130 -0
  20. package/dist/cjs/EntityManager/rehydrateIndexItem.js +65 -0
  21. package/dist/cjs/EntityManager/rehydratePageKeyMap.js +103 -0
  22. package/dist/cjs/EntityManager/removeKeys.js +51 -0
  23. package/dist/cjs/EntityManager/unwrapIndex.js +59 -0
  24. package/dist/cjs/EntityManager/updateItemHashKey.js +79 -0
  25. package/dist/cjs/EntityManager/updateItemRangeKey.js +65 -0
  26. package/dist/cjs/EntityManager/validateEntityToken.js +17 -0
  27. package/dist/cjs/EntityManager/validateGeneratedProperty.js +23 -0
  28. package/dist/cjs/EntityManager/validateIndexToken.js +16 -0
  29. package/dist/cjs/EntityManager/validateTranscodedProperty.js +16 -0
  30. package/dist/cjs/index.js +15 -0
  31. package/dist/default/lib/EntityManager/EntityManager.js +46 -69
  32. package/dist/default/lib/EntityManager/PrivateEntityManager.js +44 -51
  33. package/dist/index.d.ts +1163 -0
  34. package/dist/mjs/BaseEntityClient/BaseEntityClient.js +26 -0
  35. package/dist/mjs/BaseQueryBuilder/BaseQueryBuilder.js +60 -0
  36. package/dist/mjs/EntityManager/EntityManager.js +129 -0
  37. package/dist/mjs/EntityManager/ParsedConfig.js +383 -0
  38. package/dist/mjs/EntityManager/addKeys.js +58 -0
  39. package/dist/mjs/EntityManager/createEntityManager.js +44 -0
  40. package/dist/mjs/EntityManager/decodeElement.js +44 -0
  41. package/dist/mjs/EntityManager/decodeGeneratedProperty.js +51 -0
  42. package/dist/mjs/EntityManager/dehydrateIndexItem.js +66 -0
  43. package/dist/mjs/EntityManager/dehydratePageKeyMap.js +91 -0
  44. package/dist/mjs/EntityManager/encodeElement.js +38 -0
  45. package/dist/mjs/EntityManager/encodeGeneratedProperty.js +53 -0
  46. package/dist/mjs/EntityManager/findIndexToken.js +8 -0
  47. package/dist/mjs/EntityManager/getHashKeySpace.js +87 -0
  48. package/dist/mjs/EntityManager/getIndexComponents.js +21 -0
  49. package/dist/mjs/EntityManager/getPrimaryKey.js +74 -0
  50. package/dist/mjs/EntityManager/getShardBump.js +22 -0
  51. package/dist/mjs/EntityManager/query.js +128 -0
  52. package/dist/mjs/EntityManager/rehydrateIndexItem.js +63 -0
  53. package/dist/mjs/EntityManager/rehydratePageKeyMap.js +101 -0
  54. package/dist/mjs/EntityManager/removeKeys.js +49 -0
  55. package/dist/mjs/EntityManager/unwrapIndex.js +57 -0
  56. package/dist/mjs/EntityManager/updateItemHashKey.js +77 -0
  57. package/dist/mjs/EntityManager/updateItemRangeKey.js +63 -0
  58. package/dist/mjs/EntityManager/validateEntityToken.js +15 -0
  59. package/dist/mjs/EntityManager/validateGeneratedProperty.js +21 -0
  60. package/dist/mjs/EntityManager/validateIndexToken.js +14 -0
  61. package/dist/mjs/EntityManager/validateTranscodedProperty.js +14 -0
  62. package/dist/mjs/index.js +5 -0
  63. package/docs/.nojekyll +1 -0
  64. package/docs/assets/hierarchy.js +1 -0
  65. package/docs/assets/highlight.css +99 -0
  66. package/docs/assets/icons.js +18 -0
  67. package/docs/assets/icons.svg +1 -0
  68. package/docs/assets/main.js +60 -0
  69. package/docs/assets/navigation.js +1 -0
  70. package/docs/assets/search.js +1 -0
  71. package/docs/assets/style.css +1648 -0
  72. package/docs/classes/index.BaseEntityClient.html +124 -0
  73. package/docs/classes/index.BaseQueryBuilder.html +229 -0
  74. package/docs/classes/index.EntityManager.html +510 -0
  75. package/docs/documents/CHANGELOG.html +1432 -0
  76. package/docs/documents/guides_stan-assistant-guide.html +431 -0
  77. package/docs/functions/index.createEntityManager.html +60 -0
  78. package/docs/hierarchy.html +31 -0
  79. package/docs/index.html +212 -0
  80. package/docs/interfaces/index.BaseConfigMap.html +113 -0
  81. package/docs/interfaces/index.BaseEntityClientOptions.html +82 -0
  82. package/docs/interfaces/index.BaseQueryBuilderOptions.html +92 -0
  83. package/docs/interfaces/index.CapturedConfigMapFrom.html +126 -0
  84. package/docs/interfaces/index.ConfigInput.html +189 -0
  85. package/docs/interfaces/index.ParsedConfig.html +144 -0
  86. package/docs/interfaces/index.ParsedEntityConfig.html +91 -0
  87. package/docs/interfaces/index.ParsedGeneratedPropertiesConfig.html +67 -0
  88. package/docs/interfaces/index.ParsedIndexConfig.html +79 -0
  89. package/docs/interfaces/index.ParsedTranscoder.html +71 -0
  90. package/docs/interfaces/index.QueryOptions.html +180 -0
  91. package/docs/interfaces/index.QueryResult.html +91 -0
  92. package/docs/interfaces/index.ShardBump.html +79 -0
  93. package/docs/interfaces/index.ShardQueryResult.html +93 -0
  94. package/docs/modules/index.html +47 -0
  95. package/docs/modules.html +38 -0
  96. package/docs/sitemap.xml +263 -0
  97. package/docs/types/index.BaseKeyTokens.html +39 -0
  98. package/docs/types/index.Config.html +75 -0
  99. package/docs/types/index.ConfigMap.html +41 -0
  100. package/docs/types/index.ConfigOfClient.html +45 -0
  101. package/docs/types/index.EntitiesFromSchema.html +39 -0
  102. package/docs/types/index.EntityClientItemByToken.html +45 -0
  103. package/docs/types/index.EntityClientRecordByToken.html +43 -0
  104. package/docs/types/index.EntityItem.html +41 -0
  105. package/docs/types/index.EntityItemPartial.html +44 -0
  106. package/docs/types/index.EntityKey.html +40 -0
  107. package/docs/types/index.EntityOfToken.html +39 -0
  108. package/docs/types/index.EntityRecord.html +39 -0
  109. package/docs/types/index.EntityRecordPartial.html +40 -0
  110. package/docs/types/index.EntityToken.html +40 -0
  111. package/docs/types/index.FallbackIndexTokenSet.html +40 -0
  112. package/docs/types/index.HasIndexFor.html +43 -0
  113. package/docs/types/index.HashKeyFrom.html +38 -0
  114. package/docs/types/index.IndexComponentTokens.html +45 -0
  115. package/docs/types/index.IndexHashKeyOf.html +42 -0
  116. package/docs/types/index.IndexRangeKeyOf.html +41 -0
  117. package/docs/types/index.IndexTokensFrom.html +41 -0
  118. package/docs/types/index.IndexTokensOf.html +40 -0
  119. package/docs/types/index.KeysFrom.html +38 -0
  120. package/docs/types/index.PageKey.html +40 -0
  121. package/docs/types/index.PageKeyByIndex.html +46 -0
  122. package/docs/types/index.PresentIndexTokenSet.html +45 -0
  123. package/docs/types/index.Projected.html +39 -0
  124. package/docs/types/index.QueryBuilderQueryOptions.html +45 -0
  125. package/docs/types/index.QueryOptionsByCC.html +49 -0
  126. package/docs/types/index.QueryOptionsByCF.html +47 -0
  127. package/docs/types/index.RangeKeyFrom.html +38 -0
  128. package/docs/types/index.ShardQueryFunction.html +63 -0
  129. package/docs/types/index.ShardQueryMap.html +56 -0
  130. package/docs/types/index.ShardQueryMapByCC.html +49 -0
  131. package/docs/types/index.ShardQueryMapByCF.html +47 -0
  132. package/docs/types/index.ShardedKeysFrom.html +38 -0
  133. package/docs/types/index.StorageItem.html +42 -0
  134. package/docs/types/index.StorageRecord.html +40 -0
  135. package/docs/types/index.TranscodedPropertiesFrom.html +38 -0
  136. package/docs/types/index.UnshardedKeysFrom.html +38 -0
  137. package/docs/types/index.ValidateConfigMap.html +40 -0
  138. package/lib/EntityManager/PrivateEntityManager.js +4 -0
  139. package/package.json +1 -1
package/docs/interfaces/index.BaseConfigMap.html ADDED
@@ -0,0 +1,113 @@
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>BaseConfigMap | @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">BaseConfigMap</a></li></ul>
13
+ <h1>Interface BaseConfigMap</h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>Default type parameter for <a href="../types/index.ConfigMap.html" class="tsd-kind-type-alias"><code>ConfigMap</code></a>.</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseConfigMap</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#entitymap">EntityMap</a><span class="tsd-signature-symbol">:</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.EntityMap.html" class="tsd-signature-type external" target="_blank">EntityMap</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#hashkey">HashKey</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="#rangekey">RangeKey</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="#shardedkeys">ShardedKeys</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="#transcodedproperties">TranscodedProperties</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="#transcoderegistry">TranscodeRegistry</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#unshardedkeys">UnshardedKeys</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 tsd-hierarchy" data-refl="71">
19
+ <h4>Hierarchy (<a href="../hierarchy.html#index.BaseConfigMap">View Summary</a>)</h4>
20
+ <ul class="tsd-hierarchy">
21
+ <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BaseConfigMap</span>
22
+ <ul class="tsd-hierarchy">
23
+ <li class="tsd-hierarchy-item"><a href="index.CapturedConfigMapFrom.html" class="tsd-signature-type tsd-kind-interface">CapturedConfigMapFrom</a></li></ul></li></ul></section><aside class="tsd-sources">
24
+ <ul>
25
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/BaseConfigMap.ts#L11">EntityManager/BaseConfigMap.ts:11</a></li></ul></aside>
26
+ <section class="tsd-panel-group tsd-index-group">
27
+ <section class="tsd-panel tsd-index-panel">
28
+ <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>
29
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
30
+ <div class="tsd-accordion-details">
31
+ <section class="tsd-index-section">
32
+ <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>
33
+ <div class="tsd-index-list"><a href="#entitymap" 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/>Map</span></a>
34
+ <a href="#hashkey" 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</span></a>
35
+ <a href="#rangekey" 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>Range<wbr/>Key</span></a>
36
+ <a href="#shardedkeys" 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>Sharded<wbr/>Keys</span></a>
37
+ <a href="#transcodedproperties" 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>Transcoded<wbr/>Properties</span></a>
38
+ <a href="#transcoderegistry" 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>Transcode<wbr/>Registry</span></a>
39
+ <a href="#unshardedkeys" 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>Unsharded<wbr/>Keys</span></a>
40
+ </div></section></div></details></section></section>
41
+ <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>
42
+ <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>
43
+ <section>
44
+ <section class="tsd-panel tsd-member">
45
+ <h3 class="tsd-anchor-link" id="entitymap"><span>Entity<wbr/>Map</span><a href="#entitymap" 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>
46
+ <div class="tsd-signature"><span class="tsd-kind-property">EntityMap</span><span class="tsd-signature-symbol">:</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.EntityMap.html" class="tsd-signature-type external" target="_blank">EntityMap</a></div>
47
+ <div class="tsd-comment tsd-typography"><p>Entity map type (entity token -&gt; entity shape).</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/BaseConfigMap.ts#L13">EntityManager/BaseConfigMap.ts:13</a></li></ul></aside></section>
51
+ <section class="tsd-panel tsd-member">
52
+ <h3 class="tsd-anchor-link" id="hashkey"><span>Hash<wbr/>Key</span><a href="#hashkey" 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">HashKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
54
+ <div class="tsd-comment tsd-typography"><p>Global hash-key property name used by the storage layer.</p>
55
+ </div><aside class="tsd-sources">
56
+ <ul>
57
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/BaseConfigMap.ts#L16">EntityManager/BaseConfigMap.ts:16</a></li></ul></aside></section>
58
+ <section class="tsd-panel tsd-member">
59
+ <h3 class="tsd-anchor-link" id="rangekey"><span>Range<wbr/>Key</span><a href="#rangekey" 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>
60
+ <div class="tsd-signature"><span class="tsd-kind-property">RangeKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
61
+ <div class="tsd-comment tsd-typography"><p>Global range-key property name used by the storage layer.</p>
62
+ </div><aside class="tsd-sources">
63
+ <ul>
64
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/BaseConfigMap.ts#L19">EntityManager/BaseConfigMap.ts:19</a></li></ul></aside></section>
65
+ <section class="tsd-panel tsd-member">
66
+ <h3 class="tsd-anchor-link" id="shardedkeys"><span>Sharded<wbr/>Keys</span><a href="#shardedkeys" 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>
67
+ <div class="tsd-signature"><span class="tsd-kind-property">ShardedKeys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
68
+ <div class="tsd-comment tsd-typography"><p>Union of sharded generated key tokens (string-valued generated properties).</p>
69
+ </div><aside class="tsd-sources">
70
+ <ul>
71
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/BaseConfigMap.ts#L22">EntityManager/BaseConfigMap.ts:22</a></li></ul></aside></section>
72
+ <section class="tsd-panel tsd-member">
73
+ <h3 class="tsd-anchor-link" id="transcodedproperties"><span>Transcoded<wbr/>Properties</span><a href="#transcodedproperties" 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>
74
+ <div class="tsd-signature"><span class="tsd-kind-property">TranscodedProperties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
75
+ <div class="tsd-comment tsd-typography"><p>Union of transcoded property tokens (domain properties mapped in <code>propertyTranscodes</code>).</p>
76
+ </div><aside class="tsd-sources">
77
+ <ul>
78
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/BaseConfigMap.ts#L28">EntityManager/BaseConfigMap.ts:28</a></li></ul></aside></section>
79
+ <section class="tsd-panel tsd-member">
80
+ <h3 class="tsd-anchor-link" id="transcoderegistry"><span>Transcode<wbr/>Registry</span><a href="#transcoderegistry" 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>
81
+ <div class="tsd-signature"><span class="tsd-kind-property">TranscodeRegistry</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
82
+ <div class="tsd-comment tsd-typography"><p>Transcode registry mapping transcode names to value types.</p>
83
+ </div><aside class="tsd-sources">
84
+ <ul>
85
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/BaseConfigMap.ts#L31">EntityManager/BaseConfigMap.ts:31</a></li></ul></aside></section>
86
+ <section class="tsd-panel tsd-member">
87
+ <h3 class="tsd-anchor-link" id="unshardedkeys"><span>Unsharded<wbr/>Keys</span><a href="#unshardedkeys" 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>
88
+ <div class="tsd-signature"><span class="tsd-kind-property">UnshardedKeys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
89
+ <div class="tsd-comment tsd-typography"><p>Union of unsharded generated key tokens (string-valued generated properties).</p>
90
+ </div><aside class="tsd-sources">
91
+ <ul>
92
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/BaseConfigMap.ts#L25">EntityManager/BaseConfigMap.ts:25</a></li></ul></aside></section></section></details></div>
93
+ <div class="col-sidebar">
94
+ <div class="page-menu">
95
+ <div class="tsd-navigation settings">
96
+ <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>
97
+ <h3>Settings</h3></summary>
98
+ <div class="tsd-accordion-details">
99
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
100
+ <ul id="tsd-filter-options">
101
+ <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>
102
+ <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>
103
+ <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>
104
+ <h3>On This Page</h3></summary>
105
+ <div class="tsd-accordion-details">
106
+ <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>
107
+ <div><a href="#entitymap"><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/>Map</span></a><a href="#hashkey"><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</span></a><a href="#rangekey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Range<wbr/>Key</span></a><a href="#shardedkeys"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Sharded<wbr/>Keys</span></a><a href="#transcodedproperties"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Transcoded<wbr/>Properties</span></a><a href="#transcoderegistry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Transcode<wbr/>Registry</span></a><a href="#unshardedkeys"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Unsharded<wbr/>Keys</span></a></div></details></div></details></div>
108
+ <div class="site-menu">
109
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
110
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
111
+ <li>Loading...</li></ul></nav></div></div></div><footer>
112
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
113
+ <div class="overlay"></div></body></html>
package/docs/interfaces/index.BaseEntityClientOptions.html ADDED
@@ -0,0 +1,82 @@
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>BaseEntityClientOptions | @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">BaseEntityClientOptions</a></li></ul>
13
+ <h1>Interface BaseEntityClientOptions&lt;CC, CF&gt;</h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>Base EntityClient options.</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseEntityClientOptions</span><span class="tsd-signature-symbol">&lt;</span><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> <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">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#batchprocessoptions">batchProcessOptions</a><span class="tsd-signature-symbol">?:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" class="tsd-signature-type external" target="_blank">Omit</a><span class="tsd-signature-symbol">&lt;</span><br/>        <a href="https://docs.karmanivero.us/batch-process/interfaces/batch_process.BatchProcessOptions.html" class="tsd-signature-type external" target="_blank">BatchProcessOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><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-signature-type">&quot;batchHandler&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;unprocessedItemExtractor&quot;</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="#entitymanager">entityManager</a><span class="tsd-signature-symbol">:</span> <a href="../classes/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><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#logger">logger</a><span class="tsd-signature-symbol">?:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys" class="tsd-signature-type external" target="_blank">Pick</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Console</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;error&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;debug&quot;</span><span class="tsd-signature-symbol">&gt;</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="cf"><span class="tsd-kind-type-parameter">CF</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section><aside class="tsd-sources">
25
+ <ul>
26
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClientOptions.ts#L14">BaseEntityClient/BaseEntityClientOptions.ts:14</a></li></ul></aside>
27
+ <section class="tsd-panel-group tsd-index-group">
28
+ <section class="tsd-panel tsd-index-panel">
29
+ <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>
30
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
31
+ <div class="tsd-accordion-details">
32
+ <section class="tsd-index-section">
33
+ <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>
34
+ <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>
35
+ <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>
36
+ <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>
37
+ </div></section></div></details></section></section>
38
+ <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>
39
+ <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>
40
+ <section>
41
+ <section class="tsd-panel tsd-member">
42
+ <h3 class="tsd-anchor-link" id="batchprocessoptions"><code class="tsd-tag">Optional</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>
43
+ <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#omittype-keys" class="tsd-signature-type external" target="_blank">Omit</a><span class="tsd-signature-symbol">&lt;</span><br/>    <a href="https://docs.karmanivero.us/batch-process/interfaces/batch_process.BatchProcessOptions.html" class="tsd-signature-type external" target="_blank">BatchProcessOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><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-signature-type">&quot;batchHandler&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;unprocessedItemExtractor&quot;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></div>
44
+ <div class="tsd-comment tsd-typography"><p>Default batch process options.</p>
45
+ </div><aside class="tsd-sources">
46
+ <ul>
47
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClientOptions.ts#L19">BaseEntityClient/BaseEntityClientOptions.ts:19</a></li></ul></aside></section>
48
+ <section class="tsd-panel tsd-member">
49
+ <h3 class="tsd-anchor-link" id="entitymanager"><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>
50
+ <div class="tsd-signature"><span class="tsd-kind-property">entityManager</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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>
51
+ <div class="tsd-comment tsd-typography"><p><a href="../classes/index.EntityManager.html" class="tsd-kind-class"><code>EntityManager</code></a> instance.</p>
52
+ </div><aside class="tsd-sources">
53
+ <ul>
54
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClientOptions.ts#L25">BaseEntityClient/BaseEntityClientOptions.ts:25</a></li></ul></aside></section>
55
+ <section class="tsd-panel tsd-member">
56
+ <h3 class="tsd-anchor-link" id="logger"><code class="tsd-tag">Optional</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>
57
+ <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#picktype-keys" class="tsd-signature-type external" target="_blank">Pick</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Console</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;error&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;debug&quot;</span><span class="tsd-signature-symbol">&gt;</span></div>
58
+ <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>
59
+ </div><aside class="tsd-sources">
60
+ <ul>
61
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseEntityClient/BaseEntityClientOptions.ts#L28">BaseEntityClient/BaseEntityClientOptions.ts:28</a></li></ul></aside></section></section></details></div>
62
+ <div class="col-sidebar">
63
+ <div class="page-menu">
64
+ <div class="tsd-navigation settings">
65
+ <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>
66
+ <h3>Settings</h3></summary>
67
+ <div class="tsd-accordion-details">
68
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
69
+ <ul id="tsd-filter-options">
70
+ <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>
71
+ <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>
72
+ <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>
73
+ <h3>On This Page</h3></summary>
74
+ <div class="tsd-accordion-details">
75
+ <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>
76
+ <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>
77
+ <div class="site-menu">
78
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
79
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
80
+ <li>Loading...</li></ul></nav></div></div></div><footer>
81
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
82
+ <div class="overlay"></div></body></html>
package/docs/interfaces/index.BaseQueryBuilderOptions.html ADDED
@@ -0,0 +1,92 @@
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>BaseQueryBuilderOptions | @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">BaseQueryBuilderOptions</a></li></ul>
13
+ <h1>Interface BaseQueryBuilderOptions&lt;CC, EntityClient&gt;</h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>Constructor options for <a href="../classes/index.BaseQueryBuilder.html" class="tsd-kind-class"><code>BaseQueryBuilder</code></a>.</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseQueryBuilderOptions</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="#entityclient">EntityClient</a> <span class="tsd-signature-keyword">extends</span> <a href="../classes/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 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="#entityclient-1">entityClient</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><br/>    <a class="tsd-kind-property" href="#entitytoken">entityToken</a><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><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#hashkeytoken">hashKeyToken</a><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><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> 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="entityclient"><span class="tsd-kind-type-parameter">EntityClient</span> <span class="tsd-signature-keyword">extends</span> <a href="../classes/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>
25
+ <div class="tsd-comment tsd-typography"><p><a href="../classes/index.BaseEntityClient.html" class="tsd-kind-class"><code>BaseEntityClient</code></a> derived class instance.</p>
26
+ </div></li></ul></section><aside class="tsd-sources">
27
+ <ul>
28
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilderOptions.ts#L15">BaseQueryBuilder/BaseQueryBuilderOptions.ts:15</a></li></ul></aside>
29
+ <section class="tsd-panel-group tsd-index-group">
30
+ <section class="tsd-panel tsd-index-panel">
31
+ <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>
32
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
33
+ <div class="tsd-accordion-details">
34
+ <section class="tsd-index-section">
35
+ <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>
36
+ <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>
37
+ <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>
38
+ <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>
39
+ <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>
40
+ </div></section></div></details></section></section>
41
+ <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>
42
+ <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>
43
+ <section>
44
+ <section class="tsd-panel tsd-member">
45
+ <h3 class="tsd-anchor-link" id="entityclient-1"><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>
46
+ <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>
47
+ <div class="tsd-comment tsd-typography"><p><a href="../classes/index.BaseEntityClient.html" class="tsd-kind-class"><code>EntityClient</code></a> instance.</p>
48
+ </div><aside class="tsd-sources">
49
+ <ul>
50
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilderOptions.ts#L20">BaseQueryBuilder/BaseQueryBuilderOptions.ts:20</a></li></ul></aside></section>
51
+ <section class="tsd-panel tsd-member">
52
+ <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>
53
+ <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>
54
+ <div class="tsd-comment tsd-typography"><p>Entity token.</p>
55
+ </div><aside class="tsd-sources">
56
+ <ul>
57
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilderOptions.ts#L23">BaseQueryBuilder/BaseQueryBuilderOptions.ts:23</a></li></ul></aside></section>
58
+ <section class="tsd-panel tsd-member">
59
+ <h3 class="tsd-anchor-link" id="hashkeytoken"><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>
60
+ <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>
61
+ <div class="tsd-comment tsd-typography"><p>Hash key token.</p>
62
+ </div><aside class="tsd-sources">
63
+ <ul>
64
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilderOptions.ts#L26">BaseQueryBuilder/BaseQueryBuilderOptions.ts:26</a></li></ul></aside></section>
65
+ <section class="tsd-panel tsd-member">
66
+ <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>
67
+ <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>
68
+ <div class="tsd-comment tsd-typography"><p>Dehydrated page key map.</p>
69
+ </div><aside class="tsd-sources">
70
+ <ul>
71
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/BaseQueryBuilder/BaseQueryBuilderOptions.ts#L29">BaseQueryBuilder/BaseQueryBuilderOptions.ts:29</a></li></ul></aside></section></section></details></div>
72
+ <div class="col-sidebar">
73
+ <div class="page-menu">
74
+ <div class="tsd-navigation settings">
75
+ <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>
76
+ <h3>Settings</h3></summary>
77
+ <div class="tsd-accordion-details">
78
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
79
+ <ul id="tsd-filter-options">
80
+ <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>
81
+ <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>
82
+ <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>
83
+ <h3>On This Page</h3></summary>
84
+ <div class="tsd-accordion-details">
85
+ <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>
86
+ <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="#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>
87
+ <div class="site-menu">
88
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
89
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
90
+ <li>Loading...</li></ul></nav></div></div></div><footer>
91
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
92
+ <div class="overlay"></div></body></html>
package/docs/interfaces/index.CapturedConfigMapFrom.html ADDED
@@ -0,0 +1,126 @@
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>CapturedConfigMapFrom | @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">CapturedConfigMapFrom</a></li></ul>
13
+ <h1>Interface CapturedConfigMapFrom&lt;CC, EM&gt;</h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>Captures a BaseConfigMap-compatible type from a literal ConfigInput value
16
+ and an EntityMap (defaults to MinimalEntityMapFrom<CC>).</p>
17
+ </div></section>
18
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CapturedConfigMapFrom</span><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="#em">EM</a> <span class="tsd-signature-keyword">extends</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.EntityMap.html" class="tsd-signature-type external" target="_blank">EntityMap</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#entitymap">EntityMap</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#em">EM</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#hashkey">HashKey</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.HashKeyFrom.html" class="tsd-signature-type tsd-kind-type-alias">HashKeyFrom</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-kind-property" href="#rangekey">RangeKey</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.RangeKeyFrom.html" class="tsd-signature-type tsd-kind-type-alias">RangeKeyFrom</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-kind-property" href="#shardedkeys">ShardedKeys</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.ShardedKeysFrom.html" class="tsd-signature-type tsd-kind-type-alias">ShardedKeysFrom</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-kind-property" href="#transcodedproperties">TranscodedProperties</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.TranscodedPropertiesFrom.html" class="tsd-signature-type tsd-kind-type-alias">TranscodedPropertiesFrom</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-kind-property" href="#transcoderegistry">TranscodeRegistry</a><span class="tsd-signature-symbol">:</span> <a href="https://docs.karmanivero.us/entity-tools/interfaces/entity-tools.DefaultTranscodeRegistry.html" class="tsd-signature-type external" target="_blank">DefaultTranscodeRegistry</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#unshardedkeys">UnshardedKeys</a><span class="tsd-signature-symbol">:</span> <a href="../types/index.UnshardedKeysFrom.html" class="tsd-signature-type tsd-kind-type-alias">UnshardedKeysFrom</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/><span class="tsd-signature-symbol">}</span></div>
19
+ <section class="tsd-panel">
20
+ <h4>Type Parameters</h4>
21
+ <ul class="tsd-type-parameter-list">
22
+ <li><span id="cc"><span class="tsd-kind-type-parameter">CC</span></span></li>
23
+ <li><span id="em"><span class="tsd-kind-type-parameter">EM</span> <span class="tsd-signature-keyword">extends</span> <a href="https://docs.karmanivero.us/entity-tools/types/entity-tools.EntityMap.html" class="tsd-signature-type external" target="_blank">EntityMap</a></span></li></ul></section>
24
+ <section class="tsd-panel tsd-hierarchy" data-refl="167">
25
+ <h4>Hierarchy (<a href="../hierarchy.html#index.CapturedConfigMapFrom">View Summary</a>)</h4>
26
+ <ul class="tsd-hierarchy">
27
+ <li class="tsd-hierarchy-item"><a href="index.BaseConfigMap.html" class="tsd-signature-type tsd-kind-interface">BaseConfigMap</a>
28
+ <ul class="tsd-hierarchy">
29
+ <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">CapturedConfigMapFrom</span></li></ul></li></ul></section><aside class="tsd-sources">
30
+ <ul>
31
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L186">EntityManager/createEntityManager.ts:186</a></li></ul></aside>
32
+ <section class="tsd-panel-group tsd-index-group">
33
+ <section class="tsd-panel tsd-index-panel">
34
+ <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>
35
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
36
+ <div class="tsd-accordion-details">
37
+ <section class="tsd-index-section">
38
+ <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>
39
+ <div class="tsd-index-list"><a href="#entitymap" 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/>Map</span></a>
40
+ <a href="#hashkey" 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</span></a>
41
+ <a href="#rangekey" 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>Range<wbr/>Key</span></a>
42
+ <a href="#shardedkeys" 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>Sharded<wbr/>Keys</span></a>
43
+ <a href="#transcodedproperties" 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>Transcoded<wbr/>Properties</span></a>
44
+ <a href="#transcoderegistry" 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>Transcode<wbr/>Registry</span></a>
45
+ <a href="#unshardedkeys" 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>Unsharded<wbr/>Keys</span></a>
46
+ </div></section></div></details></section></section>
47
+ <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>
48
+ <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>
49
+ <section>
50
+ <section class="tsd-panel tsd-member">
51
+ <h3 class="tsd-anchor-link" id="entitymap"><span>Entity<wbr/>Map</span><a href="#entitymap" 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>
52
+ <div class="tsd-signature"><span class="tsd-kind-property">EntityMap</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#em">EM</a></div>
53
+ <div class="tsd-comment tsd-typography"><p>Entity map type (from schemas when provided; otherwise broad).</p>
54
+ </div><aside class="tsd-sources">
55
+ <p>Overrides <a href="index.BaseConfigMap.html">BaseConfigMap</a>.<a href="index.BaseConfigMap.html#entitymap">EntityMap</a></p>
56
+ <ul>
57
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L191">EntityManager/createEntityManager.ts:191</a></li></ul></aside></section>
58
+ <section class="tsd-panel tsd-member">
59
+ <h3 class="tsd-anchor-link" id="hashkey"><span>Hash<wbr/>Key</span><a href="#hashkey" 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>
60
+ <div class="tsd-signature"><span class="tsd-kind-property">HashKey</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.HashKeyFrom.html" class="tsd-signature-type tsd-kind-type-alias">HashKeyFrom</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></div>
61
+ <div class="tsd-comment tsd-typography"><p>Hash key token captured from the config literal.</p>
62
+ </div><aside class="tsd-sources">
63
+ <p>Overrides <a href="index.BaseConfigMap.html">BaseConfigMap</a>.<a href="index.BaseConfigMap.html#hashkey">HashKey</a></p>
64
+ <ul>
65
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L194">EntityManager/createEntityManager.ts:194</a></li></ul></aside></section>
66
+ <section class="tsd-panel tsd-member">
67
+ <h3 class="tsd-anchor-link" id="rangekey"><span>Range<wbr/>Key</span><a href="#rangekey" 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">RangeKey</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.RangeKeyFrom.html" class="tsd-signature-type tsd-kind-type-alias">RangeKeyFrom</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></div>
69
+ <div class="tsd-comment tsd-typography"><p>Range key token captured from the config literal.</p>
70
+ </div><aside class="tsd-sources">
71
+ <p>Overrides <a href="index.BaseConfigMap.html">BaseConfigMap</a>.<a href="index.BaseConfigMap.html#rangekey">RangeKey</a></p>
72
+ <ul>
73
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L197">EntityManager/createEntityManager.ts:197</a></li></ul></aside></section>
74
+ <section class="tsd-panel tsd-member">
75
+ <h3 class="tsd-anchor-link" id="shardedkeys"><span>Sharded<wbr/>Keys</span><a href="#shardedkeys" 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>
76
+ <div class="tsd-signature"><span class="tsd-kind-property">ShardedKeys</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.ShardedKeysFrom.html" class="tsd-signature-type tsd-kind-type-alias">ShardedKeysFrom</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></div>
77
+ <div class="tsd-comment tsd-typography"><p>Sharded generated key token union captured from the config literal.</p>
78
+ </div><aside class="tsd-sources">
79
+ <p>Overrides <a href="index.BaseConfigMap.html">BaseConfigMap</a>.<a href="index.BaseConfigMap.html#shardedkeys">ShardedKeys</a></p>
80
+ <ul>
81
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L200">EntityManager/createEntityManager.ts:200</a></li></ul></aside></section>
82
+ <section class="tsd-panel tsd-member">
83
+ <h3 class="tsd-anchor-link" id="transcodedproperties"><span>Transcoded<wbr/>Properties</span><a href="#transcodedproperties" 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>
84
+ <div class="tsd-signature"><span class="tsd-kind-property">TranscodedProperties</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.TranscodedPropertiesFrom.html" class="tsd-signature-type tsd-kind-type-alias">TranscodedPropertiesFrom</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></div>
85
+ <div class="tsd-comment tsd-typography"><p>Transcoded property token union captured from the config literal.</p>
86
+ </div><aside class="tsd-sources">
87
+ <p>Overrides <a href="index.BaseConfigMap.html">BaseConfigMap</a>.<a href="index.BaseConfigMap.html#transcodedproperties">TranscodedProperties</a></p>
88
+ <ul>
89
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L206">EntityManager/createEntityManager.ts:206</a></li></ul></aside></section>
90
+ <section class="tsd-panel tsd-member">
91
+ <h3 class="tsd-anchor-link" id="transcoderegistry"><span>Transcode<wbr/>Registry</span><a href="#transcoderegistry" 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>
92
+ <div class="tsd-signature"><span class="tsd-kind-property">TranscodeRegistry</span><span class="tsd-signature-symbol">:</span> <a href="https://docs.karmanivero.us/entity-tools/interfaces/entity-tools.DefaultTranscodeRegistry.html" class="tsd-signature-type external" target="_blank">DefaultTranscodeRegistry</a></div>
93
+ <div class="tsd-comment tsd-typography"><p>Transcode registry type (default registry; runtime validation still applies).</p>
94
+ </div><aside class="tsd-sources">
95
+ <p>Overrides <a href="index.BaseConfigMap.html">BaseConfigMap</a>.<a href="index.BaseConfigMap.html#transcoderegistry">TranscodeRegistry</a></p>
96
+ <ul>
97
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L209">EntityManager/createEntityManager.ts:209</a></li></ul></aside></section>
98
+ <section class="tsd-panel tsd-member">
99
+ <h3 class="tsd-anchor-link" id="unshardedkeys"><span>Unsharded<wbr/>Keys</span><a href="#unshardedkeys" 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>
100
+ <div class="tsd-signature"><span class="tsd-kind-property">UnshardedKeys</span><span class="tsd-signature-symbol">:</span> <a href="../types/index.UnshardedKeysFrom.html" class="tsd-signature-type tsd-kind-type-alias">UnshardedKeysFrom</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></div>
101
+ <div class="tsd-comment tsd-typography"><p>Unsharded generated key token union captured from the config literal.</p>
102
+ </div><aside class="tsd-sources">
103
+ <p>Overrides <a href="index.BaseConfigMap.html">BaseConfigMap</a>.<a href="index.BaseConfigMap.html#unshardedkeys">UnshardedKeys</a></p>
104
+ <ul>
105
+ <li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L203">EntityManager/createEntityManager.ts:203</a></li></ul></aside></section></section></details></div>
106
+ <div class="col-sidebar">
107
+ <div class="page-menu">
108
+ <div class="tsd-navigation settings">
109
+ <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>
110
+ <h3>Settings</h3></summary>
111
+ <div class="tsd-accordion-details">
112
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
113
+ <ul id="tsd-filter-options">
114
+ <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>
115
+ <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>
116
+ <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>
117
+ <h3>On This Page</h3></summary>
118
+ <div class="tsd-accordion-details">
119
+ <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>
120
+ <div><a href="#entitymap"><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/>Map</span></a><a href="#hashkey"><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</span></a><a href="#rangekey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Range<wbr/>Key</span></a><a href="#shardedkeys"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Sharded<wbr/>Keys</span></a><a href="#transcodedproperties"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Transcoded<wbr/>Properties</span></a><a href="#transcoderegistry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Transcode<wbr/>Registry</span></a><a href="#unshardedkeys"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Unsharded<wbr/>Keys</span></a></div></details></div></details></div>
121
+ <div class="site-menu">
122
+ <nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
123
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
124
+ <li>Loading...</li></ul></nav></div></div></div><footer>
125
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
126
+ <div class="overlay"></div></body></html>