> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/ahmadawais/ramadan-cli/llms.txt > Use this file to discover all available pages before exploring further. # Types > TypeScript interfaces and type definitions ## Overview Ramadan CLI is written in TypeScript and exports all type definitions. All API responses are validated at runtime using [Zod](https://zod.dev) schemas. ## Prayer Data Types ### PrayerTimings Contains all prayer times for a day. ```typescript theme={null} interface PrayerTimings { readonly Fajr: string; readonly Sunrise: string; readonly Dhuhr: string; readonly Asr: string; readonly Sunset: string; readonly Maghrib: string; readonly Isha: string; readonly Imsak: string; readonly Midnight: string; readonly Firstthird: string; readonly Lastthird: string; } ``` Fajr prayer time (e.g., "05:30") Sunrise time (not a prayer) Dhuhr (midday) prayer time Asr (afternoon) prayer time Sunset time (not a prayer) Maghrib prayer time (immediately after sunset) Isha (night) prayer time Imsak time (10 minutes before Fajr, used in Ramadan) Islamic midnight (midpoint between sunset and sunrise) End of first third of the night Start of last third of the night ### PrayerData Complete prayer data response from the API. ```typescript theme={null} interface PrayerData { readonly timings: PrayerTimings; readonly date: { readonly readable: string; readonly timestamp: string; readonly hijri: HijriDate; readonly gregorian: GregorianDate; }; readonly meta: PrayerMeta; } ``` All prayer times for the day Date information Human-readable date (e.g., "15 Mar 2024") Unix timestamp as string Hijri (Islamic) date information Gregorian date information Calculation metadata (method, school, coordinates, timezone) ### NextPrayerData Extends `PrayerData` with next prayer information. ```typescript theme={null} interface NextPrayerData { readonly timings: PrayerTimings; readonly date: PrayerData['date']; readonly meta: PrayerMeta; readonly nextPrayer: string; readonly nextPrayerTime: string; } ``` Name of next prayer (e.g., "Asr", "Maghrib") Time of next prayer (e.g., "16:30") ### PrayerMeta Metadata about prayer time calculation. ```typescript theme={null} interface PrayerMeta { readonly latitude: number; readonly longitude: number; readonly timezone: string; readonly method: { readonly id: number; readonly name: string; }; readonly school: | { readonly id: number; readonly name: string; } | string; } ``` Latitude used for calculation Longitude used for calculation IANA timezone string Calculation method information Method ID (0-23) Method name (e.g., "University of Islamic Sciences, Karachi") Asr school information (may be string or object) ## Date Types ### HijriDate Hijri (Islamic) calendar date. ```typescript theme={null} interface HijriDate { readonly date: string; readonly day: string; readonly month: { readonly number: number; readonly en: string; readonly ar: string; }; readonly year: string; readonly weekday: { readonly en: string; readonly ar: string; }; } ``` Full date string (e.g., "15-09-1445") Day of month (e.g., "15") Month number (1-12, 9 = Ramadan) English month name (e.g., "Ramadan") Arabic month name (e.g., "رَمَضان") Hijri year (e.g., "1445") English weekday name Arabic weekday name ### GregorianDate Gregorian calendar date. ```typescript theme={null} interface GregorianDate { readonly date: string; readonly day: string; readonly month: { readonly number: number; readonly en: string; }; readonly year: string; readonly weekday: { readonly en: string; }; } ``` Full date string (e.g., "15-03-2024") Day of month (e.g., "15") Month number (1-12) English month name (e.g., "March") Gregorian year (e.g., "2024") English weekday name (e.g., "Friday") ## Geolocation Types ### GeoLocation Complete location data with coordinates and timezone. ```typescript theme={null} interface GeoLocation { readonly city: string; readonly country: string; readonly latitude: number; readonly longitude: number; readonly timezone: string; } ``` City name Country name Latitude coordinate Longitude coordinate IANA timezone string ### CityCountryGuess City resolution result (timezone may be missing). ```typescript theme={null} interface CityCountryGuess { readonly city: string; readonly country: string; readonly latitude: number; readonly longitude: number; readonly timezone?: string; } ``` IANA timezone string (may be undefined) ## Calculation Method Types ### CalculationMethod Prayer time calculation method details. ```typescript theme={null} interface CalculationMethod { readonly id: number; readonly name: string; readonly params: { readonly Fajr: number; readonly Isha: number | string; }; } ``` Method ID (0-23) Full method name (e.g., "Islamic Society of North America (ISNA)") Calculation parameters Fajr angle in degrees Isha angle in degrees or fixed time offset ### MethodsResponse Record of all available calculation methods. ```typescript theme={null} type MethodsResponse = Readonly>; ``` Example: ```typescript theme={null} { "0": { id: 0, name: "Jafari (Shia Ithna-Ashari)", params: { ... } }, "1": { id: 1, name: "University of Islamic Sciences, Karachi", params: { ... } }, "2": { id: 2, name: "Islamic Society of North America (ISNA)", params: { ... } }, // ... } ``` ### MethodId Branded type for type-safe method IDs. ```typescript theme={null} type MethodId = number & { readonly __brand: 'MethodId' }; ``` ## Qibla Types ### QiblaData Qibla direction information. ```typescript theme={null} interface QiblaData { readonly latitude: number; readonly longitude: number; readonly direction: number; } ``` Input latitude Input longitude Qibla bearing in degrees from North (0-360) ## Configuration Types ### StoredLocation Stored location data (all fields optional). ```typescript theme={null} interface StoredLocation { readonly city?: string | undefined; readonly country?: string | undefined; readonly latitude?: number | undefined; readonly longitude?: number | undefined; } ``` ### StoredPrayerSettings Stored prayer calculation settings. ```typescript theme={null} interface StoredPrayerSettings { readonly method: number; readonly school: number; readonly timezone?: string | undefined; } ``` Calculation method ID (defaults to 2) Asr school: 0 (Shafi) or 1 (Hanafi) (defaults to 0) Timezone override ## Function Option Types ### FetchByCityOptions ```typescript theme={null} interface FetchByCityOptions { readonly city: string; readonly country: string; readonly method?: number; readonly school?: number; readonly date?: Date; } ``` ### FetchByAddressOptions ```typescript theme={null} interface FetchByAddressOptions { readonly address: string; readonly method?: number; readonly school?: number; readonly date?: Date; } ``` ### FetchByCoordsOptions ```typescript theme={null} interface FetchByCoordsOptions { readonly latitude: number; readonly longitude: number; readonly method?: number; readonly school?: number; readonly timezone?: string; readonly date?: Date; } ``` ### FetchNextPrayerOptions ```typescript theme={null} interface FetchNextPrayerOptions { readonly latitude: number; readonly longitude: number; readonly method?: number; readonly school?: number; readonly timezone?: string; } ``` ### FetchCalendarByCityOptions ```typescript theme={null} interface FetchCalendarByCityOptions { readonly city: string; readonly country: string; readonly year: number; readonly month?: number; readonly method?: number; readonly school?: number; } ``` ### FetchCalendarByAddressOptions ```typescript theme={null} interface FetchCalendarByAddressOptions { readonly address: string; readonly year: number; readonly month?: number; readonly method?: number; readonly school?: number; } ``` ### FetchHijriCalendarByCityOptions ```typescript theme={null} interface FetchHijriCalendarByCityOptions { readonly city: string; readonly country: string; readonly year: number; readonly month: number; // Required for Hijri calendar readonly method?: number; readonly school?: number; } ``` ### FetchHijriCalendarByAddressOptions ```typescript theme={null} interface FetchHijriCalendarByAddressOptions { readonly address: string; readonly year: number; readonly month: number; // Required for Hijri calendar readonly method?: number; readonly school?: number; } ``` ## Usage with TypeScript ### Import Types ```typescript theme={null} import type { PrayerData, PrayerTimings, HijriDate, GregorianDate, PrayerMeta, GeoLocation, QiblaData, CalculationMethod, MethodsResponse, } from 'ramadan-cli'; ``` ### Type Guards All API responses are validated at runtime: ```typescript theme={null} import { fetchTimingsByCity } from 'ramadan-cli'; // Response is guaranteed to match PrayerData interface const data = await fetchTimingsByCity({ city: 'Lahore', country: 'Pakistan', }); // TypeScript knows the exact shape const fajr: string = data.timings.Fajr; const hijriMonth: string = data.date.hijri.month.en; ``` ### Readonly Types All types use `readonly` modifiers to prevent accidental mutations: ```typescript theme={null} const data = await fetchTimingsByCity({ city: 'Lahore', country: 'Pakistan' }); // TypeScript error: Cannot assign to 'Fajr' because it is a read-only property data.timings.Fajr = '06:00'; ``` ## Runtime Validation All API responses are validated using Zod schemas. If the API returns unexpected data, an error is thrown: ```typescript theme={null} try { const data = await fetchTimingsByCity({ city: 'Invalid', country: 'Invalid', }); } catch (error) { // Error: Invalid API response: ... } ```