useIntervalFn

カテゴリ

アニメーション

エクスポートサイズ

341 B

最終更新

先週

コントロール付きのsetIntervalのラッパー

デモ

ソース

こんにちは

間隔

使い方

import { useIntervalFn } from '@vueuse/core'

const { pause, resume, isActive } = useIntervalFn(() => {
  /* your function */
}, 1000)

型宣言

export interface UseIntervalFnOptions {
  /**
   * Start the timer immediately
   *
   * @default true
   */
  immediate?: boolean
  /**
   * Execute the callback immediately after calling `resume`
   *
   * @default false
   */
  immediateCallback?: boolean
}
/**
 * Wrapper for `setInterval` with controls
 *
 * @param cb
 * @param interval
 * @param options
 */
export declare function useIntervalFn(
  cb: Fn,
  interval?: MaybeRefOrGetter<number>,
  options?: UseIntervalFnOptions,
): Pausable

ソース

ソース • デモ • ドキュメント

貢献者

Anthony Fu

Jelf

Lapor Chen

Anthony Fu

Börge Kiss

Dan Rose

sun0day

Enzo Innocenzi

wwj

Matvey Melishev

meteorlxy

Aurélio A. Heckert

xuxuhahaha

Hogne Vevle

Daiki Ojima

変更履歴

v12.0.0-beta.1 2024年11月21日

0a9ed - feat!: Vue 2 のサポートを削除し、バンドルを最適化してクリーンアップしました (#4349)

v11.2.0 2024年10月30日

59f8c - 修正: コールバックで pause が呼び出された後にタイマーが設定されないようにしました (#4258)

v10.0.0-beta.5 2023年4月13日

cb644 - リファクタリング!: isFunction および isString ユーティリティを削除

v10.0.0-beta.4 2023年4月13日

4d757 - feat(types)!: MaybeComputedRef を MaybeRefOrGetter にリネーム

0a72b - feat(toValue): resolveUnref を toValue にリネーム

v9.12.0 2023年1月29日

39183 - feat(useRafFn, useIntervalFn, useTimeoutFn): ステータスを読み取り専用にする (#2685)

v9.7.0 2022年12月16日

8bb7b - fix: 単なる参照ではなく計算された参照を監視する (#2539)