npm - @rvoh/dream - Versions diffs - 0.29.1 - Mend

@rvoh/dream 0.29.1

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 (1019) hide show

package/docs/index.html ADDED Viewed

@@ -0,0 +1,123 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@rvoh/dream</h2></div><div class="tsd-panel tsd-typography"><blockquote>
+<p>ATTENTION: we are currently in the process of releasing this code to the world, as of the afternoon of March 10th, 2025. This notice will be removed, and the version of this repo will be bumped to 1.0.0, once all of the repos have been migrated to the new spaces and we can verify that it is all working. This is anticipated to take 1 day.</p>
+</blockquote>
+<p>Dream is a typescript-driven, esm-first ORM built on top of <a href="http://kysely.dev">kysely</a>. It is built to operate within the <a href="https://psychic-docs.netlify.app">Psychic web framework</a>, but can be brought into other projects and used without the encapsulating framework (though this is theoretical, and we do not encourage it at this time). It is actively being developed to support production-grade applications in use within the <a href="https://www.rvohealth.com">RVOHealth organization</a>, who has kindly sponsored the continued development of this ORM, as well as the Psychic web framework as a whole.</p>
+<p>Documentation: <a href="https://psychic-docs.netlify.app">https://psychic-docs.netlify.app</a>
+Psychic web framework github: <a href="https://github.com/rvohealth/psychic">https://github.com/rvohealth/psychic</a></p>
+<a id="md:features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Features<a href="#md:features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The dream ORM features:</p>
+<ul>
+<li>static query building engine</li>
+</ul>
+<pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;fred@fred&#39;</span><span class="hl-1"> }).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><span class="hl-7">// User[]</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;fred@fred&#39;</span><span class="hl-1"> }).</span><span class="hl-5">first</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;fred@fred&#39;</span><span class="hl-1"> }).</span><span class="hl-5">last</span><span class="hl-1">()</span><br/><span class="hl-7">// User | null</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">like</span><span class="hl-1">(</span><span class="hl-6">&#39;%fred@%&#39;</span><span class="hl-1">) })</span><br/><span class="hl-1">  .</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;desc&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  .</span><span class="hl-5">limit</span><span class="hl-1">(</span><span class="hl-8">3</span><span class="hl-1">)</span><br/><span class="hl-1">  .</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// User[]</span>
+</code><button type="button">Copy</button></pre>
+<ul>
+<li>model hooks
+<ul>
+<li>before create</li>
+<li>before update</li>
+<li>before delete</li>
+<li>before save</li>
+<li>after create</li>
+<li>after update</li>
+<li>after delete</li>
+<li>after save</li>
+</ul>
+</li>
+</ul>
+<pre><code class="ts"><span class="hl-7">// models/composition.ts</span><br/><br/><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Composition</span><span class="hl-1"> {</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">BeforeCreate</span><span class="hl-1">()</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">setDefaultContent</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-3">if</span><span class="hl-1"> (!</span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1">) </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1"> = </span><span class="hl-6">&#39;default content&#39;</span><br/><span class="hl-1">  }</span><br/><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">AfterCreate</span><span class="hl-1">()</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">conditionallyChangeContentOnCreate</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1"> === </span><span class="hl-6">&#39;change me after create&#39;</span><span class="hl-1">) </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1"> = </span><span class="hl-6">&#39;changed after create&#39;</span><br/><span class="hl-1">  }</span><br/><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">AfterUpdate</span><span class="hl-1">()</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">conditionallyChangeContentOnUpdate</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1"> === </span><span class="hl-6">&#39;change me after update&#39;</span><span class="hl-1">) </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1"> = </span><span class="hl-6">&#39;changed after update&#39;</span><br/><span class="hl-1">  }</span><br/><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">AfterSave</span><span class="hl-1">()</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">conditionallyChangeContentOnSave</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1"> === </span><span class="hl-6">&#39;change me after save&#39;</span><span class="hl-1">) </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">content</span><span class="hl-1"> = </span><span class="hl-6">&#39;changed after save&#39;</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+<ul>
+<li>validations
+<ul>
+<li>presence</li>
+<li>length{min, max}</li>
+<li>contains{string | regex}</li>
+</ul>
+</li>
+</ul>
+<pre><code class="ts"><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> </span><span class="hl-0">extends</span><span class="hl-1"> </span><span class="hl-9">Dream</span><span class="hl-1"> {</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">  @</span><span class="hl-5">Validates</span><span class="hl-1">(</span><span class="hl-6">&#39;contains&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;@&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  @</span><span class="hl-5">Validates</span><span class="hl-1">(</span><span class="hl-6">&#39;presence&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">email</span><span class="hl-1">: </span><span class="hl-9">string</span><br/><br/><span class="hl-1">  @</span><span class="hl-5">Validates</span><span class="hl-1">(</span><span class="hl-6">&#39;length&#39;</span><span class="hl-1">, { </span><span class="hl-4">min:</span><span class="hl-1"> </span><span class="hl-8">4</span><span class="hl-1">, </span><span class="hl-4">max:</span><span class="hl-1"> </span><span class="hl-8">18</span><span class="hl-1"> })</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">password</span><span class="hl-1">: </span><span class="hl-9">string</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+<ul>
+<li>
+<p>associations</p>
+<ul>
+<li>belongs to</li>
+<li>has one</li>
+<li>has many</li>
+<li>has one through</li>
+<li>has many through</li>
+<li>has one through (nested indefinitely)</li>
+<li>has many through (nested indefinitely)</li>
+</ul>
+</li>
+</ul>
+<pre><code class="ts"><span class="hl-7">// models/user.ts</span><br/><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">HasMany</span><span class="hl-1">(</span><span class="hl-6">&#39;Composition&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">compositions</span><span class="hl-1">: </span><span class="hl-9">Composition</span><span class="hl-1">[]</span><br/><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">HasOne</span><span class="hl-1">(</span><span class="hl-6">&#39;Composition&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">mainComposition</span><span class="hl-1">: </span><span class="hl-9">Composition</span><br/><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">HasMany</span><span class="hl-1">(</span><span class="hl-6">&#39;CompositionAsset&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">    </span><span class="hl-4">through:</span><span class="hl-1"> </span><span class="hl-6">&#39;compositions&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  })</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">compositionAssets</span><span class="hl-1">: </span><span class="hl-9">CompositionAsset</span><span class="hl-1">[]</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-7">// models/composition.ts</span><br/><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Composition</span><span class="hl-1"> </span><span class="hl-0">extends</span><span class="hl-1"> </span><span class="hl-9">Dream</span><span class="hl-1"> {</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">BelongsTo</span><span class="hl-1">(</span><span class="hl-6">&#39;User&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">user</span><span class="hl-1">: </span><span class="hl-9">User</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-7">// models/composition-asset.ts</span><br/><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">CompositionAsset</span><span class="hl-1"> </span><span class="hl-0">extends</span><span class="hl-1"> </span><span class="hl-9">Dream</span><span class="hl-1"> {</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">BelongsTo</span><span class="hl-1">(</span><span class="hl-6">&#39;Composition&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">composition</span><span class="hl-1">: </span><span class="hl-9">Composition</span><br/><span class="hl-1">  ...</span><br/><span class="hl-1">}</span><br/><br/>
+</code><button type="button">Copy</button></pre>
+<ul>
+<li>
+<p>scopes</p>
+<ul>
+<li>named</li>
+<li>default</li>
+</ul>
+</li>
+<li>
+<p>single table inheritance</p>
+</li>
+</ul>
+<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1">  @</span><span class="hl-5">Scope</span><span class="hl-1">()</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-0">static</span><span class="hl-1"> </span><span class="hl-5">withFunnyName</span><span class="hl-1">(</span><span class="hl-4">query</span><span class="hl-1">: </span><span class="hl-9">Query</span><span class="hl-1">&lt;</span><span class="hl-9">User</span><span class="hl-1">&gt;) {</span><br/><span class="hl-1">    </span><span class="hl-3">return</span><span class="hl-1"> </span><span class="hl-4">query</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-6">&#39;Chalupas jr&#39;</span><span class="hl-1"> })</span><br/><span class="hl-1">  }</span><br/><br/><span class="hl-1">  </span><span class="hl-7">// this will always fire whenever queries are run against the model</span><br/><span class="hl-1">  @</span><span class="hl-5">Scope</span><span class="hl-1">({ </span><span class="hl-4">default:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> })</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-0">static</span><span class="hl-1"> </span><span class="hl-5">hideDeleted</span><span class="hl-1">(</span><span class="hl-4">query</span><span class="hl-1">: </span><span class="hl-9">Query</span><span class="hl-1">&lt;</span><span class="hl-9">User</span><span class="hl-1">&gt;) {</span><br/><span class="hl-1">    </span><span class="hl-3">return</span><span class="hl-1"> </span><span class="hl-4">query</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">deleted_at:</span><span class="hl-1"> </span><span class="hl-0">null</span><span class="hl-1"> })</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">scope</span><span class="hl-1">(</span><span class="hl-6">&#39;withFunnyName&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// will only return records with the name &quot;Chalupas jr&quot;</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:repl" class="tsd-anchor"></a><h3 class="tsd-anchor-link">REPL<a href="#md:repl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>the repl will open a console, exposing access to the test app models that are built into the framework.
+this test app is used to run all of our assertions, and is meant to be replaced by an actual app consuming this ORM.</p>
+<p>to get into the console, type:</p>
+<pre><code class="bash"><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">console</span>
+</code><button type="button">Copy</button></pre>
+<p>Once inside the repl, you are able to access all the models within the test app. All the classes are automagically imported.</p>
+<pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">create</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;hello@there&#39;</span><span class="hl-1">, </span><span class="hl-4">password:</span><span class="hl-1"> </span><span class="hl-6">&#39;howyadoin&#39;</span><span class="hl-1"> })</span><br/><span class="hl-4">user</span><span class="hl-1">.</span><span class="hl-4">email</span><span class="hl-1"> = </span><span class="hl-6">&#39;fred@flinstone&#39;</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">user</span><span class="hl-1">.</span><span class="hl-5">save</span><span class="hl-1">()</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:specs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Specs<a href="#md:specs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Running specs is very easy, not much to explain here.</p>
+<pre><code><span class="hl-4">yarn</span><span class="hl-1"> </span><span class="hl-4">spec</span>
+</code><button>Copy</button></pre>
+<p>We are using jest under the hood, and have a plugin enabled called <code>jest-plugin-context</code>, which allows us to branch specs out using the <code>context</code> function in place of <code>describe</code>, like so:</p>
+<pre><code class="ts"><span class="hl-5">describe</span><span class="hl-1">(</span><span class="hl-6">&#39;Dream#pluck&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-4">user1</span><span class="hl-1">: </span><span class="hl-9">User</span><br/><span class="hl-1">  </span><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-4">user2</span><span class="hl-1">: </span><span class="hl-9">User</span><br/><span class="hl-1">  </span><span class="hl-5">beforeEach</span><span class="hl-1">(</span><span class="hl-0">async</span><span class="hl-1"> () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">user1</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">create</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;fred@frewd&#39;</span><span class="hl-1">, </span><span class="hl-4">password:</span><span class="hl-1"> </span><span class="hl-6">&#39;howyadoin&#39;</span><span class="hl-1"> })</span><br/><span class="hl-1">    </span><span class="hl-4">user2</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">create</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1">, </span><span class="hl-4">password:</span><span class="hl-1"> </span><span class="hl-6">&#39;howyadoin&#39;</span><span class="hl-1"> })</span><br/><span class="hl-1">  })</span><br/><br/><span class="hl-1">  </span><span class="hl-5">it</span><span class="hl-1">(</span><span class="hl-6">&#39;plucks the specified attributes and returns them as raw data&#39;</span><span class="hl-1">, </span><span class="hl-0">async</span><span class="hl-1"> () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">    </span><span class="hl-5">expect</span><span class="hl-1">(</span><span class="hl-4">records</span><span class="hl-1">).</span><span class="hl-5">toEqual</span><span class="hl-1">([</span><span class="hl-4">user1</span><span class="hl-1">.</span><span class="hl-4">id</span><span class="hl-1">, </span><span class="hl-4">user2</span><span class="hl-1">.</span><span class="hl-4">id</span><span class="hl-1">])</span><br/><span class="hl-1">  })</span><br/><br/><span class="hl-1">  </span><span class="hl-5">context</span><span class="hl-1">(</span><span class="hl-6">&#39;with multiple fields&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-5">it</span><span class="hl-1">(</span><span class="hl-6">&#39;should return multi-dimensional array&#39;</span><span class="hl-1">, </span><span class="hl-0">async</span><span class="hl-1"> () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">      </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">).</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;createdAt&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">      </span><span class="hl-5">expect</span><span class="hl-1">(</span><span class="hl-4">records</span><span class="hl-1">).</span><span class="hl-5">toEqual</span><span class="hl-1">([</span><br/><span class="hl-1">        [</span><span class="hl-4">user1</span><span class="hl-1">.</span><span class="hl-4">id</span><span class="hl-1">, </span><span class="hl-4">user1</span><span class="hl-1">.</span><span class="hl-4">created_at</span><span class="hl-1">],</span><br/><span class="hl-1">        [</span><span class="hl-4">user2</span><span class="hl-1">.</span><span class="hl-4">id</span><span class="hl-1">, </span><span class="hl-4">user2</span><span class="hl-1">.</span><span class="hl-4">created_at</span><span class="hl-1">],</span><br/><span class="hl-1">      ])</span><br/><span class="hl-1">    })</span><br/><span class="hl-1">  })</span><br/><span class="hl-1">})</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:cli" class="tsd-anchor"></a><h3 class="tsd-anchor-link">CLI<a href="#md:cli" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">build</span><br/><span class="hl-7"># builds source code using the typescript compiler, sending it into the dist folder</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">spec</span><br/><span class="hl-7"># runs core development specs (same as yarn dream spec --core)</span><br/><br/><span class="hl-4">SQL_LOGGING</span><span class="hl-1">=</span><span class="hl-6">1</span><span class="hl-1"> </span><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">spec</span><br/><span class="hl-7"># runs core development specs, printing SQL queries</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">console</span><br/><span class="hl-7"># opens console, providing access to the internal test-app/app/models folder (same as yarn dream console --core)</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><br/><span class="hl-7"># opens a small node cli program, which right now only provides commands for generating dreams and migrations,</span><br/><span class="hl-7"># but which will likely eventually encompass all of the above commands</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">db:migrate</span><span class="hl-1"> </span><span class="hl-0">--core</span><br/><span class="hl-7"># runs migrations for core development. Use this if you are working on the dream ORM source code.</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">db:migrate</span><br/><span class="hl-7"># runs migrations for an app that is consuming the dream ORM. This is meant to be run from another repo,</span><br/><span class="hl-7"># e.g. within a different app&#39;s package.json:</span><br/><span class="hl-7">#</span><br/><span class="hl-7">#  &quot;scripts&quot;: {</span><br/><span class="hl-7">#     &quot;db:migrate&quot;: &quot;yarn --cwd=node_modules/dream db:migrate&quot;</span><br/><span class="hl-7"># }</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">sync:schema</span><br/><span class="hl-7"># syncs db schema from an app that is consuming the dream ORM. This is necessary, because in order to provide</span><br/><span class="hl-7"># deep integration with kysely, we must actually introspect the schema of your app and provide it</span><br/><span class="hl-7"># as part of the dream orm source code build. It essentially scans your database, examines all tables, outputs interfaces that kysely can consume, puts them into a file, and exports all the interfaces within that file.</span><br/><br/><span class="hl-7"># the sync command is already run as part of the migration sequence, so there should be no need to</span><br/><span class="hl-7"># run it manually. Simply run migrations to have the syncing done for you.</span><br/><br/><span class="hl-7"># A copy of this is output to your app (though don&#39;t bother manually modifying it, since it is blown away each</span><br/><span class="hl-7"># time you run migrations). It is then copied over to the node_modules/dream/src/sync folder, so that importing</span><br/><span class="hl-7"># the dream orm can provide that integration for you.</span><br/><br/><span class="hl-7"># This is meant to be run from another repo,</span><br/><span class="hl-7"># e.g. within a different app&#39;s package.json:</span><br/><span class="hl-7">#</span><br/><span class="hl-7">#  &quot;scripts&quot;: {</span><br/><span class="hl-7">#     &quot;sync:schema&quot;: &quot;yarn --cwd=node_modules/dream sync:schema&quot;</span><br/><span class="hl-7"># }</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">sync:schema</span><span class="hl-1"> </span><span class="hl-0">--core</span><br/><span class="hl-7"># runs the same sync script mentioned above, but for core development. You would run this if you were trying to</span><br/><span class="hl-7"># sync for the test-app, which is used to seed the local tests and provide models for use within the console.</span><br/><span class="hl-7"># Similar to above, a local copy of schema is kept within test-app/types/dream.ts, which is updated each time you</span><br/><span class="hl-7"># run yarn core:db:migrate.</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">sync:associations</span><br/><span class="hl-7"># runs a script which analyzes your models, building a mapping of the associations into typescript interfaces</span><br/><span class="hl-7"># which will assist in providing enforced type completion mechanisms at the code composition level. This must be</span><br/><span class="hl-7"># this is used by the underlying `load` method, as well as `preload` and `joins` methods within the query</span><br/><span class="hl-7"># building layer. This is all copied to the file specified in the `.dream.yml#associations_path`. This is also automatically done whenever you run migrations, run specs, or open a console</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">sync:associations</span><span class="hl-1"> </span><span class="hl-0">--core</span><br/><span class="hl-7"># same as above, but copies the associations.ts file to test-app/db/associations.ts</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">db:drop</span><span class="hl-1"> </span><span class="hl-0">--core</span><br/><span class="hl-7"># drops the db for either the core app or a consuming app (which is why there is no &quot;core:db:drop&quot; variant)</span><br/><br/><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">dream</span><span class="hl-1"> </span><span class="hl-6">db:create</span><span class="hl-1"> </span><span class="hl-0">--core</span><br/><span class="hl-7"># creates the db for either the core app or a consuming app (which is why there is no &quot;core:db:create&quot; variant)</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:similarity-matching" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Similarity matching<a href="#md:similarity-matching" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Dream provides a similarity searching library out of the box which allows you to implement fuzzy-searching in your app. To use it, first write a migration.</p>
+<pre><code class="bash"><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">psy</span><span class="hl-1"> </span><span class="hl-6">g:migration</span><span class="hl-1"> </span><span class="hl-6">add_fuzzy_search_to_users</span>
+</code><button type="button">Copy</button></pre>
+<p>Open the generated migration, create the pg_trgm extension and create a gin index for a field on your model</p>
+<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Kysely</span><span class="hl-1">, </span><span class="hl-4">sql</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-6">&#39;kysely&#39;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">createGinIndex</span><span class="hl-1">, </span><span class="hl-4">createExtension</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-6">&#39;@rvohealth/dream&#39;</span><br/><br/><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-5">up</span><span class="hl-1">(</span><span class="hl-4">db</span><span class="hl-1">: </span><span class="hl-9">Kysely</span><span class="hl-1">&lt;</span><span class="hl-9">any</span><span class="hl-1">&gt;): </span><span class="hl-9">Promise</span><span class="hl-1">&lt;</span><span class="hl-9">void</span><span class="hl-1">&gt; {</span><br/><span class="hl-1">  </span><span class="hl-7">// this only needs to be run once per db</span><br/><span class="hl-1">  </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-5">createExtension</span><span class="hl-1">(</span><span class="hl-6">&#39;pg_trgm&#39;</span><span class="hl-1">, </span><span class="hl-4">db</span><span class="hl-1">)</span><br/><br/><span class="hl-1">  </span><span class="hl-7">// this is not necessary, but it will dramatically improve the search</span><br/><span class="hl-1">  </span><span class="hl-7">// speed once your db has enough records for it to matter</span><br/><span class="hl-1">  </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-5">createGinIndex</span><span class="hl-1">(</span><span class="hl-6">&#39;users&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;name&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;users_name_gin_index&#39;</span><span class="hl-1">, </span><span class="hl-4">db</span><span class="hl-1">)</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-5">down</span><span class="hl-1">(</span><span class="hl-4">db</span><span class="hl-1">: </span><span class="hl-9">Kysely</span><span class="hl-1">&lt;</span><span class="hl-9">any</span><span class="hl-1">&gt;): </span><span class="hl-9">Promise</span><span class="hl-1">&lt;</span><span class="hl-9">void</span><span class="hl-1">&gt; {</span><br/><span class="hl-1">  </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">db</span><span class="hl-1">.</span><span class="hl-4">schema</span><span class="hl-1">.</span><span class="hl-5">dropIndex</span><span class="hl-1">(</span><span class="hl-6">&#39;users_name_gin_index&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+<p>Once done, run migrations</p>
+<pre><code class="bash"><span class="hl-4">NODE_ENV</span><span class="hl-1">=</span><span class="hl-6">development</span><span class="hl-1"> </span><span class="hl-5">yarn</span><span class="hl-1"> </span><span class="hl-6">psy</span><span class="hl-1"> </span><span class="hl-6">db:migrate</span>
+</code><button type="button">Copy</button></pre>
+<p>Now you can take full advantage of pg_trgm using the dream adapters!</p>
+<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">ops</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-6">&#39;@rvohealth/dream&#39;</span><br/><br/><span class="hl-7">// applies a score match of 0.3</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">users</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// applies a score match of 0.5</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">users</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">wordSimilarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// applies a score match of 0.6</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">users</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">strictWordSimilarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// applies a score match of 0.2</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">users</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">, { </span><span class="hl-4">score:</span><span class="hl-1"> </span><span class="hl-8">0.2</span><span class="hl-1"> }) }).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// this will also work for plucking, updating, joining, and aggregate functions like min, max and count</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">userIds</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">min</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">min</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">max</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">max</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">count</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">count</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">petIds</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">innerJoin</span><span class="hl-1">(</span><span class="hl-6">&#39;pets&#39;</span><span class="hl-1">, { </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;fido&#39;</span><span class="hl-1">) }).</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;pets.id&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">numUpdatedRecords</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;steeven hawkins&#39;</span><span class="hl-1">) }).</span><span class="hl-5">update</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-6">&#39;Stephen Hawking&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">})</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">users</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">innerJoin</span><span class="hl-1">(</span><span class="hl-6">&#39;pets&#39;</span><span class="hl-1">, { </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;fido&#39;</span><span class="hl-1">) }).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">first</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">pets</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">user</span><br/><span class="hl-1">  .</span><span class="hl-5">associationQuery</span><span class="hl-1">(</span><span class="hl-6">&#39;pets&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  .</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">similarity</span><span class="hl-1">(</span><span class="hl-6">&#39;fido&#39;</span><span class="hl-1">) })</span><br/><span class="hl-1">  .</span><span class="hl-5">all</span><span class="hl-1">()</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:hidden-gotchas" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Hidden gotchas<a href="#md:hidden-gotchas" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
+<li>STI descendants of the same root model that define the same association must define that association identically if they are used in joins, preload, or load. For example, the following will not work properly:</li>
+</ul>
+<pre><code class="ts"><span class="hl-1">@</span><span class="hl-5">STI</span><span class="hl-1">(</span><span class="hl-2">A</span><span class="hl-1">)</span><br/><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">B</span><span class="hl-1"> </span><span class="hl-0">extends</span><span class="hl-1"> </span><span class="hl-9">A</span><span class="hl-1"> {</span><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">HasMany</span><span class="hl-1">(</span><span class="hl-6">&#39;X&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">xx</span><span class="hl-1">: </span><span class="hl-9">X</span><span class="hl-1">[]</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-1">@</span><span class="hl-5">STI</span><span class="hl-1">(</span><span class="hl-2">A</span><span class="hl-1">)</span><br/><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">C</span><span class="hl-1"> </span><span class="hl-0">extends</span><span class="hl-1"> </span><span class="hl-9">A</span><span class="hl-1"> {</span><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">HasMany</span><span class="hl-1">(</span><span class="hl-6">&#39;X&#39;</span><span class="hl-1">, { </span><span class="hl-4">on:</span><span class="hl-1"> { </span><span class="hl-4">something:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> } })</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">xx</span><span class="hl-1">: </span><span class="hl-9">X</span><span class="hl-1">[]</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Z</span><span class="hl-1"> </span><span class="hl-0">extends</span><span class="hl-1"> </span><span class="hl-9">Dream</span><span class="hl-1"> {</span><br/><span class="hl-1">  @</span><span class="hl-4">Deco</span><span class="hl-1">.</span><span class="hl-5">HasMany</span><span class="hl-1">(</span><span class="hl-6">&#39;A&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">  </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">aa</span><span class="hl-1">: </span><span class="hl-9">A</span><span class="hl-1">[]</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-7">// this will not work as expected because the HasMany(&#39;X&#39;) are defined differently</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">z</span><span class="hl-1">.</span><span class="hl-5">load</span><span class="hl-1">({ </span><span class="hl-4">aa:</span><span class="hl-1"> </span><span class="hl-6">&#39;xx&#39;</span><span class="hl-1"> }).</span><span class="hl-5">execute</span><span class="hl-1">()</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:questions" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Questions?<a href="#md:questions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
+<li><strong>Ask them on <a href="https://stackoverflow.com">Stack Overflow</a></strong>, using the <code>[dream]</code> tag.</li>
+</ul>
+<p>Dream is an open source library, so we encourage you to actively contribute. Visit our <a href="https://github.com/rvohealth/dream/CONTRIBUTING.md">Contributing</a> guide to learn more about the processes we use for submitting pull requests or issues.</p>
+<p>Are you trying to report a possible security vulnerability? Visit our <a href="https://github.com/rvohealth/dream/SECURITY.md">Security Policy</a> for guidelines about how to proceed.</p>
+</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:features"><span>Features</span></a><ul><li><a href="#md:repl"><span>REPL</span></a></li><li><a href="#md:specs"><span>Specs</span></a></li><li><a href="#md:cli"><span>CLI</span></a></li><li><a href="#md:similarity-matching"><span>Similarity matching</span></a></li><li><ul><li><a href="#md:hidden-gotchas"><span>Hidden gotchas</span></a></li></ul></li></ul><a href="#md:questions"><span>Questions?</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/interfaces/AttributeStatement.html ADDED Viewed

@@ -0,0 +1,6 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AttributeStatement | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="AttributeStatement.html">AttributeStatement</a></li></ul><h1>Interface AttributeStatement</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AttributeStatement</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="AttributeStatement.html#field">field</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="AttributeStatement.html#functional">functional</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="AttributeStatement.html#openApiShape">openApiShape</a><span class="tsd-signature-symbol">: </span><a href="../types/OpenapiSchemaBodyShorthand.html" class="tsd-signature-type tsd-kind-type-alias">OpenapiSchemaBodyShorthand</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="AttributeStatement.html#renderAs">renderAs</a><span class="tsd-signature-symbol">?: </span><a href="../types/SerializableTypes.html" class="tsd-signature-type tsd-kind-type-alias">SerializableTypes</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="AttributeStatement.html#renderOptions">renderOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AttributeRenderOptions</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/serializer/decorators/attribute.ts#L209">src/serializer/decorators/attribute.ts:209</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="AttributeStatement.html#field" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a>
+<a href="AttributeStatement.html#functional" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>functional</span></a>
+<a href="AttributeStatement.html#openApiShape" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>open<wbr/>Api<wbr/>Shape</span></a>
+<a href="AttributeStatement.html#renderAs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>As?</span></a>
+<a href="AttributeStatement.html#renderOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>Options?</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="field" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field</span><a href="#field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/serializer/decorators/attribute.ts#L210">src/serializer/decorators/attribute.ts:210</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="functional" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>functional</span><a href="#functional" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">functional</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/serializer/decorators/attribute.ts#L211">src/serializer/decorators/attribute.ts:211</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="openApiShape" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>open<wbr/>Api<wbr/>Shape</span><a href="#openApiShape" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">open<wbr/>Api<wbr/>Shape</span><span class="tsd-signature-symbol">:</span> <a href="../types/OpenapiSchemaBodyShorthand.html" class="tsd-signature-type tsd-kind-type-alias">OpenapiSchemaBodyShorthand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/serializer/decorators/attribute.ts#L212">src/serializer/decorators/attribute.ts:212</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="renderAs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>render<wbr/>As</span><a href="#renderAs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">render<wbr/>As</span><span class="tsd-signature-symbol">?:</span> <a href="../types/SerializableTypes.html" class="tsd-signature-type tsd-kind-type-alias">SerializableTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/serializer/decorators/attribute.ts#L213">src/serializer/decorators/attribute.ts:213</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="renderOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>render<wbr/>Options</span><a href="#renderOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">render<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AttributeRenderOptions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/serializer/decorators/attribute.ts#L214">src/serializer/decorators/attribute.ts:214</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#field" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a><a href="#functional" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>functional</span></a><a href="#openApiShape" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>open<wbr/>Api<wbr/>Shape</span></a><a href="#renderAs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>As</span></a><a href="#renderOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>Options</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/interfaces/DecoratorContext.html ADDED Viewed

@@ -0,0 +1,8 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DecoratorContext | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="DecoratorContext.html">DecoratorContext</a></li></ul><h1>Interface DecoratorContext</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">DecoratorContext</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="DecoratorContext.html#access">access</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">get</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">has</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">set</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DecoratorContext.html#addInitializer">addInitializer</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DecoratorContext.html#kind">kind</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;class&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;field&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;method&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DecoratorContext.html#metadata">metadata</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DecoratorContext.html#name">name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DecoratorContext.html#private">private</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DecoratorContext.html#static">static</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L1">src/decorators/DecoratorContextType.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="DecoratorContext.html#access" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access</span></a>
+<a href="DecoratorContext.html#addInitializer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Initializer</span></a>
+<a href="DecoratorContext.html#kind" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kind</span></a>
+<a href="DecoratorContext.html#metadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata</span></a>
+<a href="DecoratorContext.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
+<a href="DecoratorContext.html#private" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private</span></a>
+<a href="DecoratorContext.html#static" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>static</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="access" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>access</span><a href="#access" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">access</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">get</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">has</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">set</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L6">src/decorators/DecoratorContextType.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="addInitializer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Initializer</span><a href="#addInitializer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">add<wbr/>Initializer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L12">src/decorators/DecoratorContextType.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="kind" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>kind</span><a href="#kind" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">kind</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;class&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;field&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;method&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L2">src/decorators/DecoratorContextType.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metadata</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L11">src/decorators/DecoratorContextType.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L3">src/decorators/DecoratorContextType.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="private" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>private</span><a href="#private" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">private</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L5">src/decorators/DecoratorContextType.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="static" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>static</span><a href="#static" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">static</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/decorators/DecoratorContextType.ts#L4">src/decorators/DecoratorContextType.ts:4</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#access" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access</span></a><a href="#addInitializer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Initializer</span></a><a href="#kind" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kind</span></a><a href="#metadata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#private" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private</span></a><a href="#static" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>static</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/interfaces/DreamApplicationInitOptions.html ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DreamApplicationInitOptions \| @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") \|\| "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="DreamApplicationInitOptions.html">DreamApplicationInitOptions</a></li></ul><h1>Interface DreamApplicationInitOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">DreamApplicationInitOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="DreamApplicationInitOptions.html#bypassModelIntegrityCheck">bypassModelIntegrityCheck</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L449">src/dream-application/index.ts:449</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="DreamApplicationInitOptions.html#bypassModelIntegrityCheck" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bypass<wbr/>Model<wbr/>Integrity<wbr/>Check?</span></a>
2	+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="bypassModelIntegrityCheck" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>bypass<wbr/>Model<wbr/>Integrity<wbr/>Check</span><a href="#bypassModelIntegrityCheck" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bypass<wbr/>Model<wbr/>Integrity<wbr/>Check</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L450">src/dream-application/index.ts:450</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#bypassModelIntegrityCheck" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bypass<wbr/>Model<wbr/>Integrity<wbr/>Check</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/interfaces/DreamApplicationOpts.html ADDED Viewed

@@ -0,0 +1,8 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DreamApplicationOpts | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="DreamApplicationOpts.html">DreamApplicationOpts</a></li></ul><h1>Interface DreamApplicationOpts</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">DreamApplicationOpts</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="DreamApplicationOpts.html#db">db</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DreamDbCredentialOptions</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DreamApplicationOpts.html#inflections">inflections</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DreamApplicationOpts.html#parallelTests">parallelTests</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DreamApplicationOpts.html#paths">paths</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DreamDirectoryPaths</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DreamApplicationOpts.html#primaryKeyType">primaryKeyType</a><span class="tsd-signature-symbol">: </span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;bigint&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;integer&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;bigserial&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;uuid&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DreamApplicationOpts.html#projectRoot">projectRoot</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="DreamApplicationOpts.html#serializerCasing">serializerCasing</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DreamSerializerCasing</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L382">src/dream-application/index.ts:382</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="DreamApplicationOpts.html#db" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>db</span></a>
+<a href="DreamApplicationOpts.html#inflections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inflections?</span></a>
+<a href="DreamApplicationOpts.html#parallelTests" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parallel<wbr/>Tests</span></a>
+<a href="DreamApplicationOpts.html#paths" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths?</span></a>
+<a href="DreamApplicationOpts.html#primaryKeyType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Key<wbr/>Type</span></a>
+<a href="DreamApplicationOpts.html#projectRoot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Root</span></a>
+<a href="DreamApplicationOpts.html#serializerCasing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>serializer<wbr/>Casing?</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="db" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db</span><a href="#db" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">db</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DreamDbCredentialOptions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L385">src/dream-application/index.ts:385</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="inflections" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>inflections</span><a href="#inflections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inflections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L386">src/dream-application/index.ts:386</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="parallelTests" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>parallel<wbr/>Tests</span><a href="#parallelTests" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parallel<wbr/>Tests</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L389">src/dream-application/index.ts:389</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="paths" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>paths</span><a href="#paths" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">paths</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DreamDirectoryPaths</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L387">src/dream-application/index.ts:387</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="primaryKeyType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>primary<wbr/>Key<wbr/>Type</span><a href="#primaryKeyType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">primary<wbr/>Key<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;bigint&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;integer&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;bigserial&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;uuid&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L384">src/dream-application/index.ts:384</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="projectRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>project<wbr/>Root</span><a href="#projectRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">project<wbr/>Root</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L383">src/dream-application/index.ts:383</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="serializerCasing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>serializer<wbr/>Casing</span><a href="#serializerCasing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">serializer<wbr/>Casing</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DreamSerializerCasing</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/97fd9b41888af1d2bfcee557ba5ff8f02495e2ea/src/dream-application/index.ts#L388">src/dream-application/index.ts:388</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><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>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#db" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>db</span></a><a href="#inflections" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inflections</span></a><a href="#parallelTests" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parallel<wbr/>Tests</span></a><a href="#paths" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths</span></a><a href="#primaryKeyType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Key<wbr/>Type</span></a><a href="#projectRoot" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Root</span></a><a href="#serializerCasing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>serializer<wbr/>Casing</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>