useApiQuery
El hook useApiQuery permite realizar consultas a una API, gestionando la caché y los errores mediante React Query.
Importación
Para importar el componente useApiQuery, se puede hacer desde fenextjs
import { useApiQuery } from "fenextjs";
Parámetros
Parámetro | Tipo | Requerido | Default | Descripcion |
---|---|---|---|---|
url | string | sí | URL de la API a consultar. | |
options | RequestInit | no | Opciones adicionales para la solicitud fetch. | |
input | I | no | Datos de entrada para la consulta, utilizados en la generación de query params. | |
key | string | sí | Clave única para la caché de React Query. | |
useUserToken | boolean | no | true | Indica si se debe incluir el token de usuario en la consulta. |
usedataFilter | boolean | no | true | Indica si se deben aplicar filtros de datos. |
usepagination | boolean | no | true | Indica si se debe incluir la paginación en la consulta. |
Returns
Parametro | Tipo | Descripcion |
---|---|---|
queryResult | IApiResult<R> | Resultado de la consulta API, incluyendo datos o errores. |
Usos
- Detectar error de API
const { data, error, isLoading } = useApiQuery({ url: "/api" });