Skip to content

Commit

Permalink
docs: generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ar1a
ar1a committed Aug 15, 2021
1 parent e30bcbf commit f37956a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
36 changes: 18 additions & 18 deletions docs/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h3>Filter</h3>
<div class="tsd-signature tsd-kind-icon">Filter&lt;Data&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PostgrestFilterBuilder</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">PostgrestFilterBuilder</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/types.ts#L6">types.ts:6</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/types.ts#L6">types.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -147,7 +147,7 @@ <h3>Use<wbr>Sign<wbr>InOptions</h3>
<div class="tsd-signature tsd-kind-icon">Use<wbr>Sign<wbr>InOptions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>redirectTo<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scopes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useSignIn.ts#L9">hooks/useSignIn.ts:9</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useSignIn.ts#L9">hooks/useSignIn.ts:9</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -168,7 +168,7 @@ <h3>Use<wbr>Single<wbr>Response</h3>
<div class="tsd-signature tsd-kind-icon">Use<wbr>Single<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">RD.RemoteData</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</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">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/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useSingle.ts#L12">hooks/useSingle.ts:12</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useSingle.ts#L12">hooks/useSingle.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand All @@ -184,7 +184,7 @@ <h3>Use<wbr>Table<wbr>Response</h3>
<div class="tsd-signature tsd-kind-icon">Use<wbr>Table<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">RD.RemoteData</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</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">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/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useTable.ts#L13">hooks/useTable.ts:13</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useTable.ts#L13">hooks/useTable.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand All @@ -203,7 +203,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Provider</h3>
<div class="tsd-signature tsd-kind-icon">Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Provider</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">default</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/ar1a/react-supabase-fp/blob/8f86ee3/src/context/context.ts#L27">context/context.ts:27</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/context/context.ts#L27">context/context.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -232,7 +232,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Supabase<wbr>Context</h3>
<div class="tsd-signature tsd-kind-icon">Supabase<wbr>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">React.Context</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SupabaseClient</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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/ar1a/react-supabase-fp/blob/8f86ee3/src/context/context.ts#L8">context/context.ts:8</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/context/context.ts#L8">context/context.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -259,7 +259,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useDelete.ts#L39">hooks/useDelete.ts:39</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useDelete.ts#L39">hooks/useDelete.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -327,7 +327,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Filter</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useFilter.ts#L16">hooks/useFilter.ts:16</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useFilter.ts#L16">hooks/useFilter.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -377,7 +377,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Insert</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useInsert.ts#L47">hooks/useInsert.ts:47</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useInsert.ts#L47">hooks/useInsert.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -454,7 +454,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Sign<wbr>In</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useSignIn.ts#L35">hooks/useSignIn.ts:35</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useSignIn.ts#L35">hooks/useSignIn.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -496,7 +496,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Sign<wbr>Out</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useSignOut.ts#L27">hooks/useSignOut.ts:27</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useSignOut.ts#L27">hooks/useSignOut.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -537,7 +537,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Single</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useSingle.ts#L41">hooks/useSingle.ts:41</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useSingle.ts#L41">hooks/useSingle.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -609,7 +609,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Supabase</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useSupabase.ts#L10">hooks/useSupabase.ts:10</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useSupabase.ts#L10">hooks/useSupabase.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -632,7 +632,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Table</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useTable.ts#L44">hooks/useTable.ts:44</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useTable.ts#L44">hooks/useTable.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -709,7 +709,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Update</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useUpdate.ts#L41">hooks/useUpdate.ts:41</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useUpdate.ts#L41">hooks/useUpdate.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -779,7 +779,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>Upsert</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useUpsert.ts#L38">hooks/useUpsert.ts:38</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useUpsert.ts#L38">hooks/useUpsert.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -843,7 +843,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>User</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useUser.ts#L30">hooks/useUser.ts:30</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useUser.ts#L30">hooks/useUser.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -865,7 +865,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr>User<wbr>Logged<wbr
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/8f86ee3/src/hooks/useUser.ts#L52">hooks/useUser.ts:52</a></li>
<li>Defined in <a href="https://github.com/ar1a/react-supabase-fp/blob/e52c1ea/src/hooks/useUser.ts#L52">hooks/useUser.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"build": "tsdx build",
"test": "tsdx test --passWithNoTests",
"lint": "eslint src",
"prepare": "npm run docs; tsdx build; husky install",
"prepare": "tsdx build; husky install",
"size": "size-limit",
"analyze": "size-limit --why",
"docs": "typedoc src/index.tsx"
Expand Down

0 comments on commit f37956a

Please sign in to comment.