-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(useTimeoutPoll): new function (#1178)
Co-authored-by: wangwenlu <wangwenlu@kuaishou.com>
- Loading branch information
Showing
5 changed files
with
132 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<script setup lang="ts"> | ||
import { ref } from 'vue-demi' | ||
import { promiseTimeout } from '@vueuse/shared' | ||
import { useTimeoutPoll } from '.' | ||
const count = ref(0) | ||
const fetchData = async() => { | ||
await promiseTimeout(1000) | ||
count.value++ | ||
} | ||
const { isActive, pause, resume } = useTimeoutPoll(fetchData, 1000) | ||
</script> | ||
|
||
<template> | ||
<div> | ||
<div>Count: {{ count }}</div> | ||
<div>isActive: {{ isActive }}</div> | ||
<div> | ||
<button @click="pause"> | ||
pause | ||
</button> | ||
<button @click="resume"> | ||
resume | ||
</button> | ||
</div> | ||
</div> | ||
</template> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
category: Utilities | ||
--- | ||
|
||
# useTimeoutPoll | ||
|
||
Use timeout to poll something. It's will trigger callback after last task is done. | ||
|
||
## Usage | ||
|
||
```ts | ||
import { useTimeoutPoll } from '@vueuse/core' | ||
|
||
const count = ref(0) | ||
|
||
const fetchData = async() => { | ||
await promiseTimeout(1000) | ||
count.value++ | ||
} | ||
|
||
// Only trigger after last fetch is done | ||
const { isActive, pause, resume } = useTimeoutPoll(fetchData, 1000) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import { ref } from 'vue-demi' | ||
import { promiseTimeout } from '@vueuse/shared' | ||
import { useTimeoutPoll } from '.' | ||
|
||
describe('useTimeoutFn', () => { | ||
it('supports reactive intervals', async() => { | ||
const callback = vitest.fn() | ||
const interval = ref(0) | ||
const { pause, resume } = useTimeoutPoll(callback, interval) | ||
|
||
resume() | ||
await promiseTimeout(1) | ||
expect(callback).toBeCalled() | ||
pause() | ||
|
||
interval.value = 50 | ||
|
||
resume() | ||
callback.mockReset() | ||
|
||
await promiseTimeout(1) | ||
expect(callback).not.toBeCalled() | ||
await promiseTimeout(101) | ||
expect(callback).toBeCalled() | ||
|
||
callback.mockReset() | ||
pause() | ||
await promiseTimeout(101) | ||
expect(callback).not.toBeCalled() | ||
|
||
resume() | ||
await promiseTimeout(1) | ||
expect(callback).toBeCalled() | ||
|
||
callback.mockReset() | ||
await promiseTimeout(101) | ||
expect(callback).toBeCalled() | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import { ref } from 'vue-demi' | ||
import type { Awaitable, MaybeRef, Pausable, TimeoutFnOptions } from '@vueuse/shared' | ||
import { tryOnScopeDispose, useTimeoutFn } from '@vueuse/shared' | ||
|
||
export function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeRef<number>, timeoutPollOptions?: TimeoutFnOptions): Pausable { | ||
const { start } = useTimeoutFn(loop, interval) | ||
|
||
const isActive = ref(false) | ||
|
||
async function loop() { | ||
if (!isActive.value) | ||
return | ||
|
||
await fn() | ||
start() | ||
} | ||
|
||
function resume() { | ||
if (!isActive.value) { | ||
isActive.value = true | ||
loop() | ||
} | ||
} | ||
|
||
function pause() { | ||
isActive.value = false | ||
} | ||
|
||
if (timeoutPollOptions?.immediate) | ||
resume() | ||
|
||
tryOnScopeDispose(pause) | ||
|
||
return { | ||
isActive, | ||
pause, | ||
resume, | ||
} | ||
} |