watchAtMost

分类

侦听

导出大小

323 B

上次更改

上个月

带有触发次数限制的 watch。

用法

类似于 watch，但额外提供了一个 count 选项，用于设置回调函数被触发的次数。达到指定次数后，该侦听器将自动停止。

import { watchAtMost
 } from '@vueuse/core'

watchAtMost
(
  source,
  () => { console
.log
('trigger!') }, // triggered it at most 3 times
  {
    count
: 3, // the number of times triggered
  },
)

类型声明

export interface WatchAtMostOptions
<Immediate
>
  extends WatchWithFilterOptions<Immediate
> {
  count
: MaybeRefOrGetter
<number>
}
export interface WatchAtMostReturn {
  stop
: WatchStopHandle

  pause
: () => void
  resume
: () => void
  count
: ShallowRef
<number>
}
export declare function watchAtMost
<
  T
 extends Readonly
<WatchSource
<unknown>[]>,
  Immediate
 extends Readonly
<boolean> = false,
>(
  sources
: [...T
],
  cb
: WatchCallback
<MapSources
<T
>, MapOldSources
<T
, Immediate
>>,
  options
: WatchAtMostOptions
<Immediate
>,
): WatchAtMostReturn
export declare function watchAtMost
<
  T
,
  Immediate
 extends Readonly
<boolean> = false,
>(
  sources
: WatchSource
<T
>,
  cb
: WatchCallback
<T
, Immediate
 extends true ? T
 | undefined : T
>,
  options
: WatchAtMostOptions
<Immediate
>,
): WatchAtMostReturn