analytica-frontend-lib
Version:
Repositório público dos componentes utilizados nas plataformas da Analytica Ensino
45 lines • 1.57 kB
TypeScript
/**
* Lesson Availability Utilities
* Helper functions for checking recommended lesson availability based on dates
*/
import { type LessonAvailabilityResult } from '../../types/lessonAvailability';
/**
* Check lesson availability based on start and end dates
* @param startDate - ISO string for lesson start date (when it becomes available)
* @param finalDate - ISO string for lesson end date (when it expires)
* @returns LessonAvailabilityResult with status and formatted dates
*
* @example
* ```typescript
* const result = checkLessonAvailability('2024-01-01', '2024-12-31');
* // { status: 'DISPONIVEL', startDate: Date, endDate: Date, ... }
* ```
*/
export declare const checkLessonAvailability: (startDate: string | null, finalDate: string | null) => LessonAvailabilityResult;
/**
* Check if a lesson is not yet available (before start date)
* @param startDate - ISO string for lesson start date
* @returns true if the lesson has not started yet
*
* @example
* ```typescript
* if (isLessonNotYetAvailable('2025-01-01')) {
* showNotAvailableModal();
* }
* ```
*/
export declare const isLessonNotYetAvailable: (startDate: string | null) => boolean;
/**
* Check if a lesson has expired (after end date)
* @param finalDate - ISO string for lesson end date
* @returns true if the lesson has expired
*
* @example
* ```typescript
* if (isLessonExpired('2023-12-31')) {
* showExpiredView();
* }
* ```
*/
export declare const isLessonExpired: (finalDate: string | null) => boolean;
//# sourceMappingURL=lessonAvailabilityUtils.d.ts.map