useTimeout

Ejecuta una función después de un período de tiempo específico.

Características

El tiempo de espera se borra automáticamente cuando el componente se desmonta.
El tiempo de espera se restablece cuando cambia delay.
Cuando cambia la devolución de llamada, el tiempo de espera no se restablece.
La llamada a la función reset cancelará el tiempo de espera anterior y comenzará uno nuevo.

Instalación

npm i @raddix/use-timeout

Uso

Ejemplo básico

Ejecutar un callback después de 3 segundos.

import { useState } from 'react';
import { useTimeout } from '@raddix/use-timeout';

export const Example = () => {
  const [isReady, setIsReady] = useState(false);

  useTimeout(() => {
    setIsReady(true);
  }, 3000);

  return <div>{isReady ? 'Ready!' : 'Waiting...'}</div>;
};

API

Parámetros

El hook acepta los siguientes 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 a la que se puede llamar para borrar el timeout.	function
reset	Una función que se puede llamar para restablecer el tiempo de espera. Esto cancelará el tiempo de espera anterior y comenzará uno nuevo.	function