Skip to content

Commit 78d7414

Browse files
junerverjunerver
committed
📝: update api documentation
1 parent d06f591 commit 78d7414

File tree

15 files changed

+539
-154
lines changed

15 files changed

+539
-154
lines changed

‎docs/api/hooks/package-list

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,12 @@ $dokka.location:xyz.junerver.compose.hooks.useredux//ReduxContext/#/PointingToDe
6060
$dokka.location:xyz.junerver.compose.hooks.useredux//ReduxProvider/#kotlin.collections.Map[kotlin.reflect.KClass[*],kotlin.Triple[kotlin.Function2[kotlin.Any,kotlin.Any,kotlin.Any],kotlin.Any,kotlin.reflect.KClass[*]]]#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-redux-provider.html
6161
$dokka.location:xyz.junerver.compose.hooks.useredux//createStore/#kotlin.Function1[xyz.junerver.compose.hooks.useredux.StoreScope,kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/create-store.html
6262
$dokka.location:xyz.junerver.compose.hooks.useredux//useDispatch/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/use-dispatch.html
63+
$dokka.location:xyz.junerver.compose.hooks.useredux//useDispatchAsync/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/use-dispatch-async.html
6364
$dokka.location:xyz.junerver.compose.hooks.useredux//useSelector/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/use-selector.html
65+
$dokka.location:xyz.junerver.compose.hooks.useredux//useSelector/#kotlin.Function1[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/use-selector.html
66+
$dokka.location:xyz.junerver.compose.hooks.useredux/DispatchAsync///PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-dispatch-async/index.html
6467
$dokka.location:xyz.junerver.compose.hooks.useredux/Store///PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-store/index.html
6568
$dokka.location:xyz.junerver.compose.hooks.useredux/StoreScope.Companion///PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-store-scope/-companion/index.html
66-
$dokka.location:xyz.junerver.compose.hooks.useredux/StoreScope.Companion/getInstance/#kotlin.collections.MutableMap[kotlin.reflect.KClass[*],kotlin.Triple[kotlin.Function2[kotlin.Any,kotlin.Any,kotlin.Any],kotlin.Any,kotlin.reflect.KClass[*]]]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-store-scope/-companion/get-instance.html
6769
$dokka.location:xyz.junerver.compose.hooks.useredux/StoreScope///PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-store-scope/index.html
6870
$dokka.location:xyz.junerver.compose.hooks.useredux/StoreScope/add/#kotlin.Pair[kotlin.Function2[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])],TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-store-scope/add.html
6971
$dokka.location:xyz.junerver.compose.hooks.useredux/StoreScope/map/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useredux/-store-scope/map.html
@@ -330,6 +332,8 @@ $dokka.location:xyz.junerver.compose.hooks//rememberUndo/#TypeParam(bounds=[kotl
330332
$dokka.location:xyz.junerver.compose.hooks//rememberUnmount/#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/remember-unmount.html
331333
$dokka.location:xyz.junerver.compose.hooks//synthesisParametersAndCheck/#kotlin.Any?#kotlin.Array[kotlin.Any?]#kotlin.reflect.KFunction[TypeParam(bounds=[kotlin.Any?])?]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/synthesis-parameters-and-check.html
332334
$dokka.location:xyz.junerver.compose.hooks//undoReducer/#xyz.junerver.compose.hooks.UndoState[TypeParam(bounds=[kotlin.Any?])]#xyz.junerver.compose.hooks.UndoAction/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/undo-reducer.html
335+
$dokka.location:xyz.junerver.compose.hooks//useAsync/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-async.html
336+
$dokka.location:xyz.junerver.compose.hooks//useAsync/#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-async.html
333337
$dokka.location:xyz.junerver.compose.hooks//useBackToFrontEffect/#kotlin.Array[kotlin.Any?]#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-back-to-front-effect.html
334338
$dokka.location:xyz.junerver.compose.hooks//useBoolean/#kotlin.Boolean/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-boolean.html
335339
$dokka.location:xyz.junerver.compose.hooks//useContext/#xyz.junerver.compose.hooks.ReactContext[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-context.html
@@ -379,6 +383,7 @@ $dokka.location:xyz.junerver.compose.hooks//useUndo/#TypeParam(bounds=[kotlin.An
379383
$dokka.location:xyz.junerver.compose.hooks//useUnmount/#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-unmount.html
380384
$dokka.location:xyz.junerver.compose.hooks//useUpdate/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-update.html
381385
$dokka.location:xyz.junerver.compose.hooks//useUpdateEffect/#kotlin.Array[kotlin.Any?]#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-update-effect.html
386+
$dokka.location:xyz.junerver.compose.hooks/AsyncRunFn///PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-async-run-fn/index.html
382387
$dokka.location:xyz.junerver.compose.hooks/Debounce///PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-debounce/index.html
383388
$dokka.location:xyz.junerver.compose.hooks/Debounce/Debounce/#kotlin.Function1[kotlin.Array[kotlin.Any?],kotlin.Unit]#kotlinx.coroutines.CoroutineScope#xyz.junerver.compose.hooks.DebounceOptions/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-debounce/-debounce.html
384389
$dokka.location:xyz.junerver.compose.hooks/Debounce/fn/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-debounce/fn.html

‎docs/api/hooks/xyz.junerver.compose.hooks.useredux/-dispatch-async/index.html

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>DispatchAsync</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../../index.html">
44+
hooks
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
</div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":hooks:dokkaHtml/release">androidJvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="classlike" id="content" pageIds="hooks::xyz.junerver.compose.hooks.useredux/DispatchAsync///PointingToDeclaration//1917587792">
65+
<div class="breadcrumbs"><a href="../../../index.html">hooks</a><span class="delimiter">/</span><a href="../index.html">xyz.junerver.compose.hooks.useredux</a><span class="delimiter">/</span><span class="current">DispatchAsync</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span>Dispatch</span><wbr></wbr><span><span>Async</span></span></h1>
68+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">typealias </span><a href="index.html">DispatchAsync</a><span class="token operator">&lt;</span><a href="index.html">A</a><span class="token operator">&gt;</span><span class="token operator"> = </span><span class="token punctuation">(</span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="index.html">A</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></div></div></div>
69+
</div>
70+
<div class="tabbedcontent">
71+
<div class="tabs-section" tabs-section="tabs-section"></div>
72+
<div class="tabs-section-body"></div>
73+
</div>
74+
</div>
75+
<div class="footer">
76+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
77+
class="pull-right"><span>Generated by </span><a
78+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
79+
</div>
80+
</div>
81+
</div>
82+
</div>
83+
</body>
84+
</html>

‎docs/api/hooks/xyz.junerver.compose.hooks.useredux/-redux-context.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<div class="cover ">
6767
<h1 class="cover"><span>Redux</span><wbr></wbr><span><span>Context</span></span></h1>
6868
</div>
69-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="-redux-context.html">ReduxContext</a><span class="token operator">: </span><a href="../xyz.junerver.compose.hooks/-react-context/index.html">ReactContext</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">, </span><a href="../xyz.junerver.compose.hooks/-dispatch/index.html">Dispatch</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div></div></div>
69+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="-redux-context.html">ReduxContext</a><span class="token operator">: </span><a href="../xyz.junerver.compose.hooks/-react-context/index.html">ReactContext</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">, </span><a href="../xyz.junerver.compose.hooks/-dispatch/index.html">Dispatch</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div><p class="paragraph">Redux context</p></div></div>
7070
</div>
7171
<div class="footer">
7272
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

‎docs/api/hooks/xyz.junerver.compose.hooks.useredux/-redux-provider.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<div class="cover ">
6767
<h1 class="cover"><span>Redux</span><wbr></wbr><span><span>Provider</span></span></h1>
6868
</div>
69-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword">fun </span><a href="-redux-provider.html"><span class="token function">ReduxProvider</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">store<span class="token operator">: </span><a href="-store/index.html">Store</a><span class="token punctuation">, </span></span><span class="parameter ">content<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a> </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div></div></div>
69+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword">fun </span><a href="-redux-provider.html"><span class="token function">ReduxProvider</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">store<span class="token operator">: </span><a href="-store/index.html">Store</a><span class="token punctuation">, </span></span><span class="parameter ">content<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a> </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Redux provider, you should provide a state store to this Provider by use <a href="create-store.html">createStore</a></p><span class="kdoc-tag"><h4 class="">Receiver</h4></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":hooks:dokkaHtml/release" data-filterable-set=":hooks:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>store</span></span></u></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":hooks:dokkaHtml/release" data-filterable-set=":hooks:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>content</span></span></u></div></span></div><div></div></div></div></div></div></div>
7070
</div>
7171
<div class="footer">
7272
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

0 commit comments

Comments
 (0)