useInterval

Ejecute una función callback en intervalos de tiempo específicos.

Características

El intervalo se borra automáticamente cuando el componente se desmonta.
Puede pausar temporalmente el intervalo estableciendo el valor de delay a null.
Cuando la devolución de llamada cambia, el intervalo no se restablece.
Cuando el delay cambia, el intervalo se restablece.
El intervalo se ejecuta inmediatamente en la primera ejecución, a menos que se establezca immediate en false.

Instalación

Instala el hook desde tu terminal.

npm i @raddix/use-interval

Uso

Ejemplo básico

Crea un contador que aumente cada segundo.

import { useState } from 'react';
import { useInterval } from '@raddix/use-interval';

export const Counter = () => {
  const [count, setCount] = useState(0);

  useInterval(() => {
    setCount(count + 1);
  }, 1000);

  return <span>{count}</span>;
};

API

Parámetros

El hook acepta tres parámetros:

Parámetro	Descripción	Requerido	Tipo
func	La función que se ejecutará cada `delay` milisegundos.	Si	function
delay	El tiempo en milisegundos que el temporizador debe retrasar entre ejecuciones de la función especificada.	Si	number
immediate	Si el intervalo debe ejecutarse inmediatamente en la primera ejecución	No	boolean

Valor de retorno

El hook devuelve un objeto con las siguientes propiedades:

Propiedad	Descripción	Tipo
clear	Una función que se puede llamar para borrar el intervalo.	function
run	Una función que se puede llamar para ejecutar el intervalo.	function