analytica-frontend-lib
Version:
Repositório público dos componentes utilizados nas plataformas da Analytica Ensino
29 lines • 867 B
TypeScript
import type { BaseApiClient } from '../../types/api';
import type { UseGeneralOverviewReturn } from './types';
/**
* Hook for fetching general overview data for simulated exams
*
* Receives the API client and calls the endpoint directly.
* Endpoint: POST /performance/simulated/general-overview
*
* @param api - API client instance (axios-like)
* @returns Hook state and methods
*
* @example
* ```tsx
* import api from '@/services/apiService';
*
* const { data, loading, error, fetchOverview } = useGeneralOverview(api);
*
* useEffect(() => {
* fetchOverview({
* period: '1_MONTH',
* schoolIds: ['school-id'],
* scoreType: 'tri',
* });
* }, []);
* ```
*/
export declare function useGeneralOverview(api: BaseApiClient): UseGeneralOverviewReturn;
export default useGeneralOverview;
//# sourceMappingURL=useGeneralOverview.d.ts.map