update docs

kysely-org · Aug 7, 2022 · 8667b2e · 8667b2e
1 parent 00b323d
commit 8667b2e
Show file tree

Hide file tree

Showing 352 changed files with 2,420 additions and 3,158 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/AliasedQueryBuilder.html b/docs/classes/AliasedQueryBuilder.html
@@ -32,7 +32,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AliasedQueryBuilder</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/query-builder/select-query-builder.ts#L1665">src/query-builder/select-query-builder.ts:1665</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/query-builder/select-query-builder.ts#L1665">src/query-builder/select-query-builder.ts:1665</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-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -73,7 +73,7 @@ <h5>queryBuilder: <a href="SelectQueryBuilder.html" class="tsd-signature-type" d
 <h5>alias: <span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="AliasedQueryBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AliasedQueryBuilder</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">DB</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TB</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">O</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/query-builder/select-query-builder.ts#L1674">src/query-builder/select-query-builder.ts:1674</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/query-builder/select-query-builder.ts#L1674">src/query-builder/select-query-builder.ts:1674</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toOperationNode" class="tsd-anchor"></a>
@@ -83,7 +83,7 @@ <h3 class="tsd-anchor-link"><span>to<wbr/>Operation<wbr/>Node</span><a href="#to
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AliasNode</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/query-builder/select-query-builder.ts#L1691">src/query-builder/select-query-builder.ts:1691</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/query-builder/select-query-builder.ts#L1691">src/query-builder/select-query-builder.ts:1691</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/classes/AliasedRawBuilder.html b/docs/classes/AliasedRawBuilder.html
@@ -32,7 +32,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><a href="../interfaces/OperationNodeSource.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationNodeSource</a></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/raw-builder/raw-builder.ts#L157">src/raw-builder/raw-builder.ts:157</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/raw-builder/raw-builder.ts#L157">src/raw-builder/raw-builder.ts:157</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-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -69,7 +69,7 @@ <h5>rawBuilder: <a href="RawBuilder.html" class="tsd-signature-type" data-tsd-ki
 <h5>alias: <span class="tsd-signature-type">AnyRawBuilder</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="AliasedRawBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AliasedRawBuilder</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">O</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/raw-builder/raw-builder.ts#L184">src/raw-builder/raw-builder.ts:184</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/raw-builder/raw-builder.ts#L184">src/raw-builder/raw-builder.ts:184</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toOperationNode" class="tsd-anchor"></a>
@@ -80,7 +80,7 @@ <h3 class="tsd-anchor-link"><span>to<wbr/>Operation<wbr/>Node</span><a href="#to
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AliasNode</span></h4><aside class="tsd-sources">
 <p>Implementation of <a href="../interfaces/OperationNodeSource.html">OperationNodeSource</a>.<a href="../interfaces/OperationNodeSource.html#toOperationNode">toOperationNode</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/raw-builder/raw-builder.ts#L175">src/raw-builder/raw-builder.ts:175</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/raw-builder/raw-builder.ts#L175">src/raw-builder/raw-builder.ts:175</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/classes/AlterColumnBuilder.html b/docs/classes/AlterColumnBuilder.html
@@ -18,7 +18,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AlterColumnBuilder</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/schema/alter-table-builder.ts#L219">src/schema/alter-table-builder.ts:219</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/schema/alter-table-builder.ts#L219">src/schema/alter-table-builder.ts:219</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-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -50,7 +50,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>props: <a href="../interfaces/AlterColumnBuilderProps.html" class="tsd-signature-type" data-tsd-kind="Interface">AlterColumnBuilderProps</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="AlterColumnBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AlterColumnBuilder</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/schema/alter-table-builder.ts#L222">src/schema/alter-table-builder.ts:222</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/schema/alter-table-builder.ts#L222">src/schema/alter-table-builder.ts:222</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="dropDefault" class="tsd-anchor"></a>
@@ -60,15 +60,15 @@ <h3 class="tsd-anchor-link"><span>drop<wbr/>Default</span><a href="#dropDefault"
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="AlterTableExecutor.html" class="tsd-signature-type" data-tsd-kind="Class">AlterTableExecutor</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/schema/alter-table-builder.ts#L248">src/schema/alter-table-builder.ts:248</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/schema/alter-table-builder.ts#L248">src/schema/alter-table-builder.ts:248</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="dropNotNull" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>drop<wbr/>Not<wbr/>Null</span><a href="#dropNotNull" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="dropNotNull.dropNotNull-1">drop<wbr/>Not<wbr/>Null<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AlterTableExecutor.html" class="tsd-signature-type" data-tsd-kind="Class">AlterTableExecutor</a><a href="#dropNotNull.dropNotNull-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="AlterTableExecutor.html" class="tsd-signature-type" data-tsd-kind="Class">AlterTableExecutor</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/schema/alter-table-builder.ts#L270">src/schema/alter-table-builder.ts:270</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/schema/alter-table-builder.ts#L270">src/schema/alter-table-builder.ts:270</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setDataType" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>set<wbr/>Data<wbr/>Type</span><a href="#setDataType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -81,7 +81,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>dataType: <a href="../types/ColumnDataType.html" class="tsd-signature-type" data-tsd-kind="Type alias">ColumnDataType</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="AlterTableExecutor.html" class="tsd-signature-type" data-tsd-kind="Class">AlterTableExecutor</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/schema/alter-table-builder.ts#L226">src/schema/alter-table-builder.ts:226</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/schema/alter-table-builder.ts#L226">src/schema/alter-table-builder.ts:226</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setDefault" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>set<wbr/>Default</span><a href="#setDefault" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -94,15 +94,15 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>value: <span class="tsd-signature-type">unknown</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="AlterTableExecutor.html" class="tsd-signature-type" data-tsd-kind="Class">AlterTableExecutor</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/schema/alter-table-builder.ts#L237">src/schema/alter-table-builder.ts:237</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/schema/alter-table-builder.ts#L237">src/schema/alter-table-builder.ts:237</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setNotNull" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>set<wbr/>Not<wbr/>Null</span><a href="#setNotNull" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="setNotNull.setNotNull-1">set<wbr/>Not<wbr/>Null<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AlterTableExecutor.html" class="tsd-signature-type" data-tsd-kind="Class">AlterTableExecutor</a><a href="#setNotNull.setNotNull-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="AlterTableExecutor.html" class="tsd-signature-type" data-tsd-kind="Class">AlterTableExecutor</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/koskimas/kysely/blob/35f2bcac/src/schema/alter-table-builder.ts#L259">src/schema/alter-table-builder.ts:259</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/koskimas/kysely/blob/00b323dc/src/schema/alter-table-builder.ts#L259">src/schema/alter-table-builder.ts:259</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">