useQueryMunisma

- Es un paquete diseñado para facilitar la gestión de estados relacionados con consultas asíncronas en aplicaciones React. Este hook permite manejar datos, adaptadores y notificaciones de manera declarativa y escalable.

Características principales

- Gestión avanzada del estado de las consultas, incluyendo estados de carga, datos y errores.
- Soporte para adaptadores para transformar datos según las necesidades del cliente.
- Configuración flexible mediante múltiples parámetros de inicialización.
- Integración fluida con TypeScript para una experiencia tipada y segura.
- Control sobre las notificaciones de estado y resultados.

Instalación

Instala el paquete desde npm:

``bash
npm install usequerymunisma
`

O directamente desde el repositorio de GitHub:

`bash
npm install pmNiko/usequerymunisma
`

Uso básico

$3

`tsx
import { useQueryState } from 'usequerymunisma';

const ExampleComponent = () => {
const {
isLoading,
stateQuery: { data, containsData },
requests: { send },
} = useQueryState('getItems', { auto: true });

if (isLoading) return

Cargando...

`tsx
import { useQueryState } from 'usequerymunisma';

const adaptData = data => data.map(item => ({ ...item, isActive: true }));

const ExampleWithAdapter = () => {
const {
isLoading,
stateAdapter: { adaptedResults },
requests: { send },
} = useQueryState('getItems', {
useAdapter: true,
adapter: adaptData,
auto: true,
});

if (isLoading) return

Cargando...

`tsx
interface FakeDataReponse {
name: string;
dni: number;
age: number;
}

const FN_Example = 'fnexample';

const mockResponse = {
estado: 1,
mensaje: null,
rowcount: 1,
datos: {
name: 'Carlos',
dni: 11222333,
age: 40,
},
};

const App = () => {
const { data, isFetching } = useQueryState(FN_Example, {
auto: true,
fetchDelay: 2000,
mode: 'mock',
mockResponse,
});

return (


{JSON.stringify(data)}

- fn (string, requerido): Nombre de la función o endpoint a consultar.
- options (opcional): Objeto de configuración con las siguientes propiedades:
- name: Identificador del servicio para depuración.
- auto: Ejecuta la consulta automáticamente al montar el componente (por defecto false).
- singleObject: Determina si los datos devueltos serán un objeto único o un arreglo (por defecto false).
- dependsOn: Dependencia para activar el fetching automático.
- searchParams: Parámetros de búsqueda iniciales.
- useAdapter: Activa el adaptador de datos.
- adapter: Función adaptadora de los datos obtenidos.
- runAfter: Objeto con configuraciones para acciones post-fetching:
- debug: Muestra información de depuración en consola.
- execute: Función a ejecutar tras completar la petición.
- fetchDelay: Tiempo de espera antes de iniciar la consulta.
- mode: Modo de ejecución (develop, mock o prod).
- mockResponse: Respuesta simulada para el modo mock.

$3

#### isLoading

Indica si la consulta está en progreso.

#### stateQuery

Objeto que contiene:

- isFetching: Si la consulta está en progreso.
- isReady: Si la consulta ha finalizado.
- containsData: Si la consulta devolvió datos.
- data: Datos obtenidos de la consulta.

#### stateAdapter

Objeto que contiene:

- isAdapting: Si el adaptador está procesando datos.
- adapterCompleted: Si el adaptador finalizó el procesamiento.
- adaptedResultsExists: Si el adaptador devolvió datos.
- adaptedResults: Datos procesados por el adaptador.

#### notify

Objeto que contiene:

- exists: Si existe una notificación.
- info: Si la notificación es informativa.
- error: Si ocurrió un error.
- message: Mensaje de la notificación.

#### requests

Métodos disponibles para interactuar con la consulta:

- send: Ejecuta la consulta con parámetros opcionales.
- search`: Ejecuta la consulta con parámetros requeridos.

Licencia

Este proyecto está licenciado bajo la MIT License.

Para más información, visita el repositorio oficial.