Hooks
useApiQuery

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ámetroTipoRequeridoDefaultDescripcion
urlstringURL de la API a consultar.
optionsRequestInitnoOpciones adicionales para la solicitud fetch.
inputInoDatos de entrada para la consulta, utilizados en la generación de query params.
keystringClave única para la caché de React Query.
useUserTokenbooleannotrueIndica si se debe incluir el token de usuario en la consulta.
usedataFilterbooleannotrueIndica si se deben aplicar filtros de datos.
usepaginationbooleannotrueIndica si se debe incluir la paginación en la consulta.

Returns

ParametroTipoDescripcion
queryResultIApiResult<R>Resultado de la consulta API, incluyendo datos o errores.

Usos

  • Detectar error de API
const { data, error, isLoading } = useApiQuery({ url: "/api" });