analytica-frontend-lib
Version:
Repositório público dos componentes utilizados nas plataformas da Analytica Ensino
36 lines • 1.05 kB
TypeScript
import type { BaseApiClient } from '../../types/api';
import type { UseAggregatedOverviewReturn } from './types';
/**
* Hook for fetching aggregated overview data (without students list)
* Supports different aggregation types: students, classes, municipalities
*
* @param api - API client with post method
*
* @example
* ```tsx
* const { data, loading, error, fetchOverview } = useAggregatedOverview(api);
*
* // For students overview
* fetchOverview({
* aggregationType: 'students',
* simulationType: 'enem-1',
* period: '1_MONTH',
* });
*
* // For classes overview (UNIT_MANAGER)
* fetchOverview({
* aggregationType: 'classes',
* simulationType: 'enem-1',
* period: '1_MONTH',
* });
*
* // For municipalities overview (REGIONAL_MANAGER)
* fetchOverview({
* aggregationType: 'municipalities',
* simulationType: 'enem-1',
* period: '1_MONTH',
* });
* ```
*/
export declare function useAggregatedOverview(api: BaseApiClient): UseAggregatedOverviewReturn;
//# sourceMappingURL=useAggregatedOverview.d.ts.map