Skip to content

fix(useTimeout): fix type typo #5147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 5, 2025
+6 −2
Merged

fix(useTimeout): fix type typo #5147

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a97af7
chore: fix typo
keeplearning66 Nov 4, 2025
b48252f
Update packages/shared/useTimeout/index.ts
keeplearning66 Nov 4, 2025
b18403b
Merge branch 'main' into chore/typo-UseTimoutReturn
antfu Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/shared/useTimeout/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ export interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutF
callback?: Fn
}

export type UseTimoutReturn = ComputedRef<boolean> | { readonly ready: ComputedRef<boolean> } & Stoppable
export type UseTimeoutReturn = ComputedRef<boolean> | { readonly ready: ComputedRef<boolean> } & Stoppable
/**
* @deprecated use UseTimeoutReturn instead
*/
export type UseTimoutReturn = UseTimeoutReturn

/**
* Update value after a given time with controls.
Expand All @@ -29,7 +33,7 @@ export type UseTimoutReturn = ComputedRef<boolean> | { readonly ready: ComputedR
*/
export function useTimeout(interval?: MaybeRefOrGetter<number>, options?: UseTimeoutOptions<false>): ComputedRef<boolean>
export function useTimeout(interval: MaybeRefOrGetter<number>, options: UseTimeoutOptions<true>): { ready: ComputedRef<boolean> } & Stoppable
export function useTimeout(interval: MaybeRefOrGetter<number> = 1000, options: UseTimeoutOptions<boolean> = {}): UseTimoutReturn {
export function useTimeout(interval: MaybeRefOrGetter<number> = 1000, options: UseTimeoutOptions<boolean> = {}): UseTimeoutReturn {
const {
controls: exposeControls = false,
callback,
Expand Down
Loading