useInterval

useInterval は、指定した間隔で関数を実行する React フックです。 タイマー、データのポーリング、その他の定期的な処理に役立ちます。

インターフェース

function useInterval(
  callback: () => void,
  options: number | { delay: number; enabled?: boolean; immediate?: boolean }
): void;

パラメータ

• callbackrequired · () => void
  

  定期的に実行する関数です。

• optionsrequired · number | { delay: number; enabled?: boolean; immediate?: boolean }
  

  定期実行の動作を設定します。

  • options.delayrequired · number
    

    実行間隔（ミリ秒）です。null の場合、定期実行は行われません。

  • options.immediateboolean · false
    

    true の場合、定期実行の開始前に即座に実行します。

  • options.enabledboolean · true
    

    false の場合、定期実行は行われません。

戻り値

この関数は値を返しません。

使用例

import { useInterval } from 'react-simplikit';
import { useState } from 'react';

function Timer() {
  const [time, setTime] = useState(0);

  useInterval(() => {
    setTime(prev => prev + 1);
  }, 1000);

  return (
    <div>
      <p>{time} seconds</p>
    </div>
  );
}