55- [ useDebounce / useDebounceFn] ( #usedebounce--usedebouncefn )
66- [ useThrottle / useThrottleFn] ( #usethrottle--usethrottlefn )
77- [ useInterval] ( #useinterval )
8- - [ useTimeout / useTimeoutFn] ( #usetimeout-- usetimeoutfn )
8+ - [ useTimeoutFn] ( #usetimeoutfn )
99- [ useTimeoutPoll] ( #usetimeoutpoll )
1010- [ useCountdown] ( #usecountdown )
1111- [ useCounter] ( #usecounter )
@@ -136,27 +136,26 @@ optionsOf = {
136136
137137---
138138
139- ## useTimeout / useTimeoutFn
139+ ## useTimeoutFn
140140
141141延时执行。
142142
143- ### useTimeoutFn
144-
145143``` kotlin
146- val (run, cancel, isPending ) = useTimeoutFn(
144+ val (isPending, start, stop ) = useTimeoutFn(
147145 fn = { showNotification() },
148146 interval = 3 .seconds
149147)
150148
151- run () // 开始计时
152- cancel() // 取消
149+ start () // 开始计时
150+ stop() // 取消
153151// isPending.value 表示是否在等待中
154152```
155153
156154** 配置选项** :
157155``` kotlin
158156useTimeoutFn(fn, interval, optionsOf = {
159157 immediate = false // 是否立即开始
158+ immediateCallback = false // 是否在开始时立即执行
160159})
161160```
162161
@@ -167,11 +166,13 @@ useTimeoutFn(fn, interval, optionsOf = {
167166超时轮询,上一次任务完成后才开始下一次。
168167
169168``` kotlin
170- val (run, cancel, isPolling) = useTimeoutPoll(
169+ val timeoutPoll = useTimeoutPoll(
171170 fn = { fetchData() },
172171 interval = 5 .seconds
173172)
174173
174+ // timeoutPoll.isActive.value / timeoutPoll.pause() / timeoutPoll.resume()
175+
175176// 自动开始
176177useTimeoutPoll(
177178 fn = { fetchData() },
@@ -188,7 +189,7 @@ useTimeoutPoll(
188189
189190``` kotlin
190191val (countdown, formattedRes) = useCountdown {
191- targetDate = Clock .System .now() + 10 .minutes
192+ targetDate = Clock .System .now() + 10 .minutes // kotlin.time.Clock
192193 interval = 1 .seconds
193194 onEnd = { showComplete() }
194195}
@@ -408,7 +409,7 @@ val now = useNow {
408409// 自定义格式
409410val now = useNow {
410411 interval = 1 .seconds
411- format = { instant -> instant .toString() }
412+ format = { epochMillis -> epochMillis .toString() }
412413}
413414```
414415
0 commit comments