@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.
- 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
|
@@ -0,0 +1,189 @@
|
|
|
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>ConfigInput | @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">ConfigInput</a></li></ul>
|
|
13
|
+
<h1>Interface ConfigInput</h1></div>
|
|
14
|
+
<section class="tsd-panel tsd-comment">
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>Values-first config input used to capture literal tokens from the provided
|
|
16
|
+
configuration value. This does not enforce full Config shape at compile
|
|
17
|
+
time; runtime validation still occurs via Zod in the EntityManager.</p>
|
|
18
|
+
<p>Keep this intentionally permissive to maximize inference from <code>as const</code>.</p>
|
|
19
|
+
</div></section>
|
|
20
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ConfigInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#entities">entities</a><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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entitiesschema">entitiesSchema</a><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"><</span><br/> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">ZodType</span><span class="tsd-signature-symbol"><</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">,</span> <span class="tsd-signature-type">$ZodTypeInternals</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#generatedkeydelimiter">generatedKeyDelimiter</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="#generatedproperties">generatedProperties</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">sharded</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">unsharded</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#generatedvaluedelimiter">generatedValueDelimiter</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="#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="#indexes">indexes</a><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"><</span><br/> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">hashKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rangeKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#propertytranscodes">propertyTranscodes</a><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"><</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><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="#shardkeydelimiter">shardKeyDelimiter</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="#throttle">throttle</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#transcodes">transcodes</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">}</span></div><aside class="tsd-sources">
|
|
21
|
+
<ul>
|
|
22
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L19">EntityManager/createEntityManager.ts:19</a></li></ul></aside>
|
|
23
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
24
|
+
<section class="tsd-panel tsd-index-panel">
|
|
25
|
+
<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>
|
|
26
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
27
|
+
<div class="tsd-accordion-details">
|
|
28
|
+
<section class="tsd-index-section">
|
|
29
|
+
<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>
|
|
30
|
+
<div class="tsd-index-list"><a href="#entities" 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>entities?</span></a>
|
|
31
|
+
<a href="#entitiesschema" 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>entities<wbr/>Schema?</span></a>
|
|
32
|
+
<a href="#generatedkeydelimiter" 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>generated<wbr/>Key<wbr/>Delimiter?</span></a>
|
|
33
|
+
<a href="#generatedproperties" 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>generated<wbr/>Properties?</span></a>
|
|
34
|
+
<a href="#generatedvaluedelimiter" 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>generated<wbr/>Value<wbr/>Delimiter?</span></a>
|
|
35
|
+
<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>
|
|
36
|
+
<a href="#indexes" 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>indexes?</span></a>
|
|
37
|
+
<a href="#propertytranscodes" 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>property<wbr/>Transcodes?</span></a>
|
|
38
|
+
<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>
|
|
39
|
+
<a href="#shardkeydelimiter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shard<wbr/>Key<wbr/>Delimiter?</span></a>
|
|
40
|
+
<a href="#throttle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>throttle?</span></a>
|
|
41
|
+
<a href="#transcodes" 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>transcodes?</span></a>
|
|
42
|
+
</div></section></div></details></section></section>
|
|
43
|
+
<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>
|
|
44
|
+
<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>
|
|
45
|
+
<section>
|
|
46
|
+
<section class="tsd-panel tsd-member">
|
|
47
|
+
<h3 class="tsd-anchor-link" id="entities"><code class="tsd-tag">Optional</code><span>entities</span><a href="#entities" 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>
|
|
48
|
+
<div class="tsd-signature"><span class="tsd-kind-property">entities</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div>
|
|
49
|
+
<div class="tsd-comment tsd-typography"><p>Optional per-entity configuration (runtime semantics).</p>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-comment tsd-typography">
|
|
52
|
+
<div class="tsd-tag-remarks">
|
|
53
|
+
<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>This is intentionally permissive in <code>ConfigInput</code>; runtime validation occurs
|
|
54
|
+
in the <a href="../classes/index.EntityManager.html" class="tsd-kind-class"><code>EntityManager</code></a> constructor via Zod.</p>
|
|
55
|
+
</div></div><aside class="tsd-sources">
|
|
56
|
+
<ul>
|
|
57
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L76">EntityManager/createEntityManager.ts:76</a></li></ul></aside></section>
|
|
58
|
+
<section class="tsd-panel tsd-member">
|
|
59
|
+
<h3 class="tsd-anchor-link" id="entitiesschema"><code class="tsd-tag">Optional</code><span>entities<wbr/>Schema</span><a href="#entitiesschema" 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">entitiesSchema</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"><</span><br/> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">ZodType</span><span class="tsd-signature-symbol"><</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">,</span> <span class="tsd-signature-type">$ZodTypeInternals</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></div>
|
|
61
|
+
<div class="tsd-comment tsd-typography"><p>Optional Zod schemas for per-entity domain shapes (non-generated fields only).</p>
|
|
62
|
+
</div>
|
|
63
|
+
<div class="tsd-comment tsd-typography">
|
|
64
|
+
<div class="tsd-tag-remarks">
|
|
65
|
+
<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>Schemas MUST declare only base (non-generated) properties. Do not include:</p>
|
|
66
|
+
<ul>
|
|
67
|
+
<li>global keys (hashKey/rangeKey), or</li>
|
|
68
|
+
<li>generated property tokens (sharded/unsharded keys).</li>
|
|
69
|
+
</ul>
|
|
70
|
+
</div></div><aside class="tsd-sources">
|
|
71
|
+
<ul>
|
|
72
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L86">EntityManager/createEntityManager.ts:86</a></li></ul></aside></section>
|
|
73
|
+
<section class="tsd-panel tsd-member">
|
|
74
|
+
<h3 class="tsd-anchor-link" id="generatedkeydelimiter"><code class="tsd-tag">Optional</code><span>generated<wbr/>Key<wbr/>Delimiter</span><a href="#generatedkeydelimiter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
75
|
+
<div class="tsd-signature"><span class="tsd-kind-property">generatedKeyDelimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
76
|
+
<div class="tsd-comment tsd-typography"><p>Optional delimiter between generated key elements (default <code>|</code>).</p>
|
|
77
|
+
</div><aside class="tsd-sources">
|
|
78
|
+
<ul>
|
|
79
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L89">EntityManager/createEntityManager.ts:89</a></li></ul></aside></section>
|
|
80
|
+
<section class="tsd-panel tsd-member">
|
|
81
|
+
<h3 class="tsd-anchor-link" id="generatedproperties"><code class="tsd-tag">Optional</code><span>generated<wbr/>Properties</span><a href="#generatedproperties" 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>
|
|
82
|
+
<div class="tsd-signature"><span class="tsd-kind-property">generatedProperties</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">sharded</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">unsharded</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
83
|
+
<div class="tsd-comment tsd-typography"><p>Optional generated property token maps.</p>
|
|
84
|
+
</div>
|
|
85
|
+
<div class="tsd-type-declaration">
|
|
86
|
+
<h4>Type Declaration</h4>
|
|
87
|
+
<ul class="tsd-parameters">
|
|
88
|
+
<li class="tsd-parameter">
|
|
89
|
+
<h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sharded</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5>
|
|
90
|
+
<div class="tsd-comment tsd-typography"><p>Sharded generated property tokens (hash-side).</p>
|
|
91
|
+
</div></li>
|
|
92
|
+
<li class="tsd-parameter">
|
|
93
|
+
<h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">unsharded</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5>
|
|
94
|
+
<div class="tsd-comment tsd-typography"><p>Unsharded generated property tokens (range-side).</p>
|
|
95
|
+
</div></li></ul></div>
|
|
96
|
+
<div class="tsd-comment tsd-typography">
|
|
97
|
+
<div class="tsd-tag-remarks">
|
|
98
|
+
<h4 class="tsd-anchor-link" id="remarks-2">Remarks<a href="#remarks-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
99
|
+
<li><code>sharded</code> keys are hash-side generated property tokens and are encoded atomically.</li>
|
|
100
|
+
<li><code>unsharded</code> keys are range-side generated property tokens.</li>
|
|
101
|
+
</ul>
|
|
102
|
+
</div></div><aside class="tsd-sources">
|
|
103
|
+
<ul>
|
|
104
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L33">EntityManager/createEntityManager.ts:33</a></li></ul></aside></section>
|
|
105
|
+
<section class="tsd-panel tsd-member">
|
|
106
|
+
<h3 class="tsd-anchor-link" id="generatedvaluedelimiter"><code class="tsd-tag">Optional</code><span>generated<wbr/>Value<wbr/>Delimiter</span><a href="#generatedvaluedelimiter" 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>
|
|
107
|
+
<div class="tsd-signature"><span class="tsd-kind-property">generatedValueDelimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
108
|
+
<div class="tsd-comment tsd-typography"><p>Optional delimiter between a generated element name and its value (default <code>#</code>).</p>
|
|
109
|
+
</div><aside class="tsd-sources">
|
|
110
|
+
<ul>
|
|
111
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L92">EntityManager/createEntityManager.ts:92</a></li></ul></aside></section>
|
|
112
|
+
<section class="tsd-panel tsd-member">
|
|
113
|
+
<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>
|
|
114
|
+
<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>
|
|
115
|
+
<div class="tsd-comment tsd-typography"><p>Global hash key property name (e.g., <code>"pk"</code>).</p>
|
|
116
|
+
</div><aside class="tsd-sources">
|
|
117
|
+
<ul>
|
|
118
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L21">EntityManager/createEntityManager.ts:21</a></li></ul></aside></section>
|
|
119
|
+
<section class="tsd-panel tsd-member">
|
|
120
|
+
<h3 class="tsd-anchor-link" id="indexes"><code class="tsd-tag">Optional</code><span>indexes</span><a href="#indexes" 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>
|
|
121
|
+
<div class="tsd-signature"><span class="tsd-kind-property">indexes</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"><</span><br/> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">hashKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rangeKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></div>
|
|
122
|
+
<div class="tsd-comment tsd-typography"><p>Optional index token map used for typing and paging-key narrowing.</p>
|
|
123
|
+
</div>
|
|
124
|
+
<div class="tsd-comment tsd-typography">
|
|
125
|
+
<div class="tsd-tag-remarks">
|
|
126
|
+
<h4 class="tsd-anchor-link" id="remarks-3">Remarks<a href="#remarks-3" 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 is provider-agnostic metadata (not a provider-specific index definition).</p>
|
|
127
|
+
</div></div><aside class="tsd-sources">
|
|
128
|
+
<ul>
|
|
129
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L55">EntityManager/createEntityManager.ts:55</a></li></ul></aside></section>
|
|
130
|
+
<section class="tsd-panel tsd-member">
|
|
131
|
+
<h3 class="tsd-anchor-link" id="propertytranscodes"><code class="tsd-tag">Optional</code><span>property<wbr/>Transcodes</span><a href="#propertytranscodes" 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>
|
|
132
|
+
<div class="tsd-signature"><span class="tsd-kind-property">propertyTranscodes</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"><</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></div>
|
|
133
|
+
<div class="tsd-comment tsd-typography"><p>Optional map of transcodable property token -> transcode name.</p>
|
|
134
|
+
</div>
|
|
135
|
+
<div class="tsd-comment tsd-typography">
|
|
136
|
+
<div class="tsd-tag-remarks">
|
|
137
|
+
<h4 class="tsd-anchor-link" id="remarks-4">Remarks<a href="#remarks-4" 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>Only properties present here are treated as “transcoded properties”.</p>
|
|
138
|
+
</div></div><aside class="tsd-sources">
|
|
139
|
+
<ul>
|
|
140
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L47">EntityManager/createEntityManager.ts:47</a></li></ul></aside></section>
|
|
141
|
+
<section class="tsd-panel tsd-member">
|
|
142
|
+
<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>
|
|
143
|
+
<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>
|
|
144
|
+
<div class="tsd-comment tsd-typography"><p>Global range key property name (e.g., <code>"sk"</code>).</p>
|
|
145
|
+
</div><aside class="tsd-sources">
|
|
146
|
+
<ul>
|
|
147
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L24">EntityManager/createEntityManager.ts:24</a></li></ul></aside></section>
|
|
148
|
+
<section class="tsd-panel tsd-member">
|
|
149
|
+
<h3 class="tsd-anchor-link" id="shardkeydelimiter"><code class="tsd-tag">Optional</code><span>shard<wbr/>Key<wbr/>Delimiter</span><a href="#shardkeydelimiter" 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>
|
|
150
|
+
<div class="tsd-signature"><span class="tsd-kind-property">shardKeyDelimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
151
|
+
<div class="tsd-comment tsd-typography"><p>Optional delimiter between entity token and shard suffix in hash key values (default <code>!</code>).</p>
|
|
152
|
+
</div><aside class="tsd-sources">
|
|
153
|
+
<ul>
|
|
154
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L95">EntityManager/createEntityManager.ts:95</a></li></ul></aside></section>
|
|
155
|
+
<section class="tsd-panel tsd-member">
|
|
156
|
+
<h3 class="tsd-anchor-link" id="throttle"><code class="tsd-tag">Optional</code><span>throttle</span><a href="#throttle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
157
|
+
<div class="tsd-signature"><span class="tsd-kind-property">throttle</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
158
|
+
<div class="tsd-comment tsd-typography"><p>Optional maximum concurrency for shard queries.</p>
|
|
159
|
+
</div><aside class="tsd-sources">
|
|
160
|
+
<ul>
|
|
161
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L101">EntityManager/createEntityManager.ts:101</a></li></ul></aside></section>
|
|
162
|
+
<section class="tsd-panel tsd-member">
|
|
163
|
+
<h3 class="tsd-anchor-link" id="transcodes"><code class="tsd-tag">Optional</code><span>transcodes</span><a href="#transcodes" 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>
|
|
164
|
+
<div class="tsd-signature"><span class="tsd-kind-property">transcodes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div>
|
|
165
|
+
<div class="tsd-comment tsd-typography"><p>Optional transcode registry/value (validated at runtime).</p>
|
|
166
|
+
</div><aside class="tsd-sources">
|
|
167
|
+
<ul>
|
|
168
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/createEntityManager.ts#L98">EntityManager/createEntityManager.ts:98</a></li></ul></aside></section></section></details></div>
|
|
169
|
+
<div class="col-sidebar">
|
|
170
|
+
<div class="page-menu">
|
|
171
|
+
<div class="tsd-navigation settings">
|
|
172
|
+
<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>
|
|
173
|
+
<h3>Settings</h3></summary>
|
|
174
|
+
<div class="tsd-accordion-details">
|
|
175
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
176
|
+
<ul id="tsd-filter-options">
|
|
177
|
+
<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>
|
|
178
|
+
<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>
|
|
179
|
+
<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>
|
|
180
|
+
<h3>On This Page</h3></summary>
|
|
181
|
+
<div class="tsd-accordion-details">
|
|
182
|
+
<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>
|
|
183
|
+
<div><a href="#entities"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entities</span></a><a href="#entitiesschema"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entities<wbr/>Schema</span></a><a href="#generatedkeydelimiter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generated<wbr/>Key<wbr/>Delimiter</span></a><a href="#generatedproperties"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generated<wbr/>Properties</span></a><a href="#generatedvaluedelimiter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generated<wbr/>Value<wbr/>Delimiter</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="#indexes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>indexes</span></a><a href="#propertytranscodes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>property<wbr/>Transcodes</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="#shardkeydelimiter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shard<wbr/>Key<wbr/>Delimiter</span></a><a href="#throttle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>throttle</span></a><a href="#transcodes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transcodes</span></a></div></details></div></details></div>
|
|
184
|
+
<div class="site-menu">
|
|
185
|
+
<nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
|
|
186
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
187
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
188
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
189
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,144 @@
|
|
|
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>ParsedConfig | @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">ParsedConfig</a></li></ul>
|
|
13
|
+
<h1>Interface ParsedConfig</h1></div>
|
|
14
|
+
<section class="tsd-panel tsd-comment">
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>Simplified runtime configuration shape after parsing/validation.</p>
|
|
16
|
+
</div>
|
|
17
|
+
<div class="tsd-comment tsd-typography">
|
|
18
|
+
<div class="tsd-tag-remarks">
|
|
19
|
+
<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>This is the type exposed by <a href="../classes/index.EntityManager.html#config" class="tsd-kind-accessor"><code>EntityManager.config</code></a>.
|
|
20
|
+
It mirrors the validated Zod schema output.</p>
|
|
21
|
+
</div></div></section>
|
|
22
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ParsedConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#entities">entities</a><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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="index.ParsedEntityConfig.html" class="tsd-signature-type tsd-kind-interface">ParsedEntityConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#generatedkeydelimiter">generatedKeyDelimiter</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="#generatedproperties">generatedProperties</a><span class="tsd-signature-symbol">:</span> <a href="index.ParsedGeneratedPropertiesConfig.html" class="tsd-signature-type tsd-kind-interface">ParsedGeneratedPropertiesConfig</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#generatedvaluedelimiter">generatedValueDelimiter</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="#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="#indexes">indexes</a><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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="index.ParsedIndexConfig.html" class="tsd-signature-type tsd-kind-interface">ParsedIndexConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#propertytranscodes">propertyTranscodes</a><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"><</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><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="#shardkeydelimiter">shardKeyDelimiter</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="#throttle">throttle</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#transcodes">transcodes</a><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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="index.ParsedTranscoder.html" class="tsd-signature-type tsd-kind-interface">ParsedTranscoder</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
23
|
+
<ul>
|
|
24
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L565">EntityManager/ParsedConfig.ts:565</a></li></ul></aside>
|
|
25
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
26
|
+
<section class="tsd-panel tsd-index-panel">
|
|
27
|
+
<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>
|
|
28
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
29
|
+
<div class="tsd-accordion-details">
|
|
30
|
+
<section class="tsd-index-section">
|
|
31
|
+
<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>
|
|
32
|
+
<div class="tsd-index-list"><a href="#entities" 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>entities</span></a>
|
|
33
|
+
<a href="#generatedkeydelimiter" 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>generated<wbr/>Key<wbr/>Delimiter</span></a>
|
|
34
|
+
<a href="#generatedproperties" 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>generated<wbr/>Properties</span></a>
|
|
35
|
+
<a href="#generatedvaluedelimiter" 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>generated<wbr/>Value<wbr/>Delimiter</span></a>
|
|
36
|
+
<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>
|
|
37
|
+
<a href="#indexes" 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>indexes</span></a>
|
|
38
|
+
<a href="#propertytranscodes" 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>property<wbr/>Transcodes</span></a>
|
|
39
|
+
<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>
|
|
40
|
+
<a href="#shardkeydelimiter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shard<wbr/>Key<wbr/>Delimiter</span></a>
|
|
41
|
+
<a href="#throttle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>throttle</span></a>
|
|
42
|
+
<a href="#transcodes" 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>transcodes</span></a>
|
|
43
|
+
</div></section></div></details></section></section>
|
|
44
|
+
<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>
|
|
45
|
+
<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>
|
|
46
|
+
<section>
|
|
47
|
+
<section class="tsd-panel tsd-member">
|
|
48
|
+
<h3 class="tsd-anchor-link" id="entities"><span>entities</span><a href="#entities" 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>
|
|
49
|
+
<div class="tsd-signature"><span class="tsd-kind-property">entities</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="index.ParsedEntityConfig.html" class="tsd-signature-type tsd-kind-interface">ParsedEntityConfig</a><span class="tsd-signature-symbol">></span></div>
|
|
50
|
+
<div class="tsd-comment tsd-typography"><p>Entity definitions keyed by entity token.</p>
|
|
51
|
+
</div><aside class="tsd-sources">
|
|
52
|
+
<ul>
|
|
53
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L567">EntityManager/ParsedConfig.ts:567</a></li></ul></aside></section>
|
|
54
|
+
<section class="tsd-panel tsd-member">
|
|
55
|
+
<h3 class="tsd-anchor-link" id="generatedkeydelimiter"><span>generated<wbr/>Key<wbr/>Delimiter</span><a href="#generatedkeydelimiter" 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>
|
|
56
|
+
<div class="tsd-signature"><span class="tsd-kind-property">generatedKeyDelimiter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
57
|
+
<div class="tsd-comment tsd-typography"><p>Delimiter between generated key elements (default <code>|</code>).</p>
|
|
58
|
+
</div><aside class="tsd-sources">
|
|
59
|
+
<ul>
|
|
60
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L575">EntityManager/ParsedConfig.ts:575</a></li></ul></aside></section>
|
|
61
|
+
<section class="tsd-panel tsd-member">
|
|
62
|
+
<h3 class="tsd-anchor-link" id="generatedproperties"><span>generated<wbr/>Properties</span><a href="#generatedproperties" 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>
|
|
63
|
+
<div class="tsd-signature"><span class="tsd-kind-property">generatedProperties</span><span class="tsd-signature-symbol">:</span> <a href="index.ParsedGeneratedPropertiesConfig.html" class="tsd-signature-type tsd-kind-interface">ParsedGeneratedPropertiesConfig</a></div>
|
|
64
|
+
<div class="tsd-comment tsd-typography"><p>Generated property token maps.</p>
|
|
65
|
+
</div><aside class="tsd-sources">
|
|
66
|
+
<ul>
|
|
67
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L569">EntityManager/ParsedConfig.ts:569</a></li></ul></aside></section>
|
|
68
|
+
<section class="tsd-panel tsd-member">
|
|
69
|
+
<h3 class="tsd-anchor-link" id="generatedvaluedelimiter"><span>generated<wbr/>Value<wbr/>Delimiter</span><a href="#generatedvaluedelimiter" 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>
|
|
70
|
+
<div class="tsd-signature"><span class="tsd-kind-property">generatedValueDelimiter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
71
|
+
<div class="tsd-comment tsd-typography"><p>Delimiter between generated element name and value (default <code>#</code>).</p>
|
|
72
|
+
</div><aside class="tsd-sources">
|
|
73
|
+
<ul>
|
|
74
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L577">EntityManager/ParsedConfig.ts:577</a></li></ul></aside></section>
|
|
75
|
+
<section class="tsd-panel tsd-member">
|
|
76
|
+
<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>
|
|
77
|
+
<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>
|
|
78
|
+
<div class="tsd-comment tsd-typography"><p>Global hash key property name.</p>
|
|
79
|
+
</div><aside class="tsd-sources">
|
|
80
|
+
<ul>
|
|
81
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L571">EntityManager/ParsedConfig.ts:571</a></li></ul></aside></section>
|
|
82
|
+
<section class="tsd-panel tsd-member">
|
|
83
|
+
<h3 class="tsd-anchor-link" id="indexes"><span>indexes</span><a href="#indexes" 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">indexes</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="index.ParsedIndexConfig.html" class="tsd-signature-type tsd-kind-interface">ParsedIndexConfig</a><span class="tsd-signature-symbol">></span></div>
|
|
85
|
+
<div class="tsd-comment tsd-typography"><p>Provider-agnostic index definitions keyed by index token.</p>
|
|
86
|
+
</div><aside class="tsd-sources">
|
|
87
|
+
<ul>
|
|
88
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L573">EntityManager/ParsedConfig.ts:573</a></li></ul></aside></section>
|
|
89
|
+
<section class="tsd-panel tsd-member">
|
|
90
|
+
<h3 class="tsd-anchor-link" id="propertytranscodes"><span>property<wbr/>Transcodes</span><a href="#propertytranscodes" 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>
|
|
91
|
+
<div class="tsd-signature"><span class="tsd-kind-property">propertyTranscodes</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"><</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></div>
|
|
92
|
+
<div class="tsd-comment tsd-typography"><p>Map of transcoded property token -> transcode name.</p>
|
|
93
|
+
</div><aside class="tsd-sources">
|
|
94
|
+
<ul>
|
|
95
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L579">EntityManager/ParsedConfig.ts:579</a></li></ul></aside></section>
|
|
96
|
+
<section class="tsd-panel tsd-member">
|
|
97
|
+
<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>
|
|
98
|
+
<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>
|
|
99
|
+
<div class="tsd-comment tsd-typography"><p>Global range key property name.</p>
|
|
100
|
+
</div><aside class="tsd-sources">
|
|
101
|
+
<ul>
|
|
102
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L581">EntityManager/ParsedConfig.ts:581</a></li></ul></aside></section>
|
|
103
|
+
<section class="tsd-panel tsd-member">
|
|
104
|
+
<h3 class="tsd-anchor-link" id="shardkeydelimiter"><span>shard<wbr/>Key<wbr/>Delimiter</span><a href="#shardkeydelimiter" 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>
|
|
105
|
+
<div class="tsd-signature"><span class="tsd-kind-property">shardKeyDelimiter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
106
|
+
<div class="tsd-comment tsd-typography"><p>Delimiter between entity token and shard suffix in hash key values (default <code>!</code>).</p>
|
|
107
|
+
</div><aside class="tsd-sources">
|
|
108
|
+
<ul>
|
|
109
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L583">EntityManager/ParsedConfig.ts:583</a></li></ul></aside></section>
|
|
110
|
+
<section class="tsd-panel tsd-member">
|
|
111
|
+
<h3 class="tsd-anchor-link" id="throttle"><span>throttle</span><a href="#throttle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
112
|
+
<div class="tsd-signature"><span class="tsd-kind-property">throttle</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
113
|
+
<div class="tsd-comment tsd-typography"><p>Default max concurrency for shard queries during EntityManager.query.</p>
|
|
114
|
+
</div><aside class="tsd-sources">
|
|
115
|
+
<ul>
|
|
116
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L585">EntityManager/ParsedConfig.ts:585</a></li></ul></aside></section>
|
|
117
|
+
<section class="tsd-panel tsd-member">
|
|
118
|
+
<h3 class="tsd-anchor-link" id="transcodes"><span>transcodes</span><a href="#transcodes" 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>
|
|
119
|
+
<div class="tsd-signature"><span class="tsd-kind-property">transcodes</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="index.ParsedTranscoder.html" class="tsd-signature-type tsd-kind-interface">ParsedTranscoder</a><span class="tsd-signature-symbol">></span></div>
|
|
120
|
+
<div class="tsd-comment tsd-typography"><p>Transcoder registry used for encoding/decoding values.</p>
|
|
121
|
+
</div><aside class="tsd-sources">
|
|
122
|
+
<ul>
|
|
123
|
+
<li>Defined in <a href="https://github.com/karmaniverous/entity-manager/blob/d2ff954ea0261727cdbac42b98076fc3e0181656/src/EntityManager/ParsedConfig.ts#L587">EntityManager/ParsedConfig.ts:587</a></li></ul></aside></section></section></details></div>
|
|
124
|
+
<div class="col-sidebar">
|
|
125
|
+
<div class="page-menu">
|
|
126
|
+
<div class="tsd-navigation settings">
|
|
127
|
+
<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>
|
|
128
|
+
<h3>Settings</h3></summary>
|
|
129
|
+
<div class="tsd-accordion-details">
|
|
130
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
131
|
+
<ul id="tsd-filter-options">
|
|
132
|
+
<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>
|
|
133
|
+
<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>
|
|
134
|
+
<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>
|
|
135
|
+
<h3>On This Page</h3></summary>
|
|
136
|
+
<div class="tsd-accordion-details">
|
|
137
|
+
<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>
|
|
138
|
+
<div><a href="#entities"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entities</span></a><a href="#generatedkeydelimiter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generated<wbr/>Key<wbr/>Delimiter</span></a><a href="#generatedproperties"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generated<wbr/>Properties</span></a><a href="#generatedvaluedelimiter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generated<wbr/>Value<wbr/>Delimiter</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="#indexes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>indexes</span></a><a href="#propertytranscodes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>property<wbr/>Transcodes</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="#shardkeydelimiter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shard<wbr/>Key<wbr/>Delimiter</span></a><a href="#throttle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>throttle</span></a><a href="#transcodes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transcodes</span></a></div></details></div></details></div>
|
|
139
|
+
<div class="site-menu">
|
|
140
|
+
<nav class="tsd-navigation"><a href="../modules.html">@karmaniverous/entity-manager</a>
|
|
141
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
142
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
143
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
144
|
+
<div class="overlay"></div></body></html>
|