An Angular api client for Prayer Times API
that you can use for:
- Computing prayer times and prayer time calendars via co-ordinates
- Computing prayer times and prayer time calendars via city and country
- Computing prayer times and prayer time calendars via an address
- Computing geographic co-ordinates and timezone by city and country
- ✅ Covers all prayertimes APIs.
- ✅ Using observable for all requests
- ✅ MIT Licensed
- ✅ Strongly typed using TypeScript
- ✅ Supports standalone Angular.
- ngx-prayertimes-api
npm install @wursha/ngx-prayertimes-api
yarn add @wursha/ngx-prayertimes-api
pnpm add @wursha/ngx-prayertimes-api
bun add @wursha/ngx-prayertimes-api
first Inject the service NgxPrayertimesApiService anywhere you want to use it
import { NgxPrayertimesApiService } from "ngx-prayertimes-api";
export class AppComponent {
constructor(public service: NgxPrayertimesApiService) {}
}and make sure that HttpClient is provided
import { provideHttpClient } from "@angular/common/http";
export const appConfig: ApplicationConfig = {
providers: [... , provideHttpClient()],
};now you are ready to use it.
getCalendar(p: getCalendarRequest): Observable<getCalendarResponse>Returns all prayer times for a specific calendar month.
getCalendarByAddress(p: getCalendarByAddressRequest): Observable<getCalendarResponse>Returns all prayer times for a specific calendar month at a particular address.
getCalendarByCity(p: getCalendarByCityRequest): Observable<getCalendarResponse>Returns all prayer times for a specific calendar month by City.
getHijriCalendar(p: getHijriCalendarRequest): Observable<getCalendarResponse>Returns all prayer times for a specific Hijri calendar month.
getHijriCalendarByAddress(p: getHijriCalendarByAddressRequest): Observable<getCalendarResponse>Returns all prayer times for a specific Hijri calendar month at a particular address.
getHijriCalendarByCity(p: getHijriCalendarByCityRequest): Observable<getCalendarResponse>Returns all prayer times for a specific Hijri calendar month by City.
getTimings(p: getTimingsRequest): Observable<getTimingsResponse>Returns all prayer times for a specific date.
getTimingsByAddress(p: getTimingsByAddressRequest): Observable<getTimingsResponse>Returns all prayer times for a specific date at a particular address.
getTimingsByCity(p: getTimingsByCityRequest): Observable<getTimingsResponse>Returns all prayer times for a specific date in a particular city.
getMethods(): Observable<getMethodsResponse>Returns all the prayer times calculation methods supported by this API. For more information on how to use custom methods, see https://aladhan.com/calculation-methods.
interface getCalendarRequest extends sharedCalendarWithYearMonthRequest {
/**
* The decimal value for the latitude co-ordinate of the location you want the time computed for. Example: 51.75865125
*/
latitude: number;
/**
* The decimal value for the longitude co-ordinate of the location you want the time computed for. Example: -1.25387785
*/
longitude: number;
/**
* A valid timezone name. Example: Europe/London. If you do not specify this, we'll calcuate it using the co-ordinates you provide.
*/
timezonestring?: TimeZone;
}
interface getCalendarByAddressRequest extends sharedCalendarWithYearMonthRequest {
/**
* An address string. Example: 1420 Austin Bluffs Parkway, Colorado Springs, CO OR 25 Hampstead High Street, London, NW3 1RL, United Kingdom OR Sultanahmet Mosque, Istanbul, Turkey
*/
address: string;
}
interface getCalendarByCityRequest extends sharedCalendarWithYearMonthRequest {
/**
* A city name. Example: London
*/
city: string;
/**
* A country name or 2 character alpha ISO 3166 code. Examples: GB or United Kindom
*/
country: string;
/**
* State or province. A state name or abbreviation. Examples: Colorado / CO / Punjab / Bengal
*/
state?: string;
}interface getHijriCalendarRequest extends getCalendarRequest {
/**
* A Hijri calendar year. Example: 1437.
*/
year: number;
/**
* A Hijri calendar month. Example: 9 or 09 for Ramadan. If not specified, an annual calendar will be returned.
*/
month?: number;
}
interface getHijriCalendarByAddressRequest extends getCalendarByAddressRequest {
/**
* A Hijri calendar year. Example: 1437.
*/
year: number;
/**
* A Hijri calendar month. Example: 9 or 09 for Ramadan. If not specified, an annual calendar will be returned.
*/
month?: number;
}
interface getHijriCalendarByCityRequest extends getCalendarByCityRequest {
/**
* A Hijri calendar year. Example: 1437.
*/
year: number;
/**
* A Hijri calendar month. Example: 9 or 09 for Ramadan. If not specified, an annual calendar will be returned.
*/
month?: number;
}interface getTimingsRequest extends sharedCalendarWithDateRequest {
/**
* The decimal value for the latitude co-ordinate of the location you want the time computed for. Example: 51.75865125
*/
latitude: number;
/**
* The decimal value for the longitude co-ordinate of the location you want the time computed for. Example: -1.25387785
*/
longitude: number;
/**
* A valid timezone name. Example: Europe/London. If you do not specify this, we'll calcuate it using the co-ordinates you provide.
*/
timezonestring?: TimeZone;
}
interface getTimingsByAddressRequest extends sharedCalendarWithDateRequest {
/**
* An address string. Example: 1420 Austin Bluffs Parkway, Colorado Springs, CO OR 25 Hampstead High Street, London, NW3 1RL, United Kingdom OR Sultanahmet Mosque, Istanbul, Turkey
*/
address: string;
}
interface getTimingsByCityRequest extends sharedCalendarWithDateRequest {
/**
* A city name. Example: London
*/
city: string;
/**
* A country name or 2 character alpha ISO 3166 code. Examples: GB or United Kindom
*/
country: string;
/**
* State or province. A state name or abbreviation. Examples: Colorado / CO / Punjab / Bengal
*/
state?: string;
}interface sharedCalendarWithYearMonthRequest extends sharedCalendarRequest {
/**
* A gregorian calendar year. Example: 2014.
*/
year: number;
/**
* A gregorian calendar month. Example: 8 or 08 for August. If not specified, an annual calendar will be returned.
*/
month?: number;
}
interface sharedCalendarWithDateRequest extends sharedCalendarRequest {
/**
* Default's to the current date via an HTTP 301.
*/
date: Date;
}
interface sharedCalendarRequest {
/**
* A prayer times calculation method. Methods identify various schools of thought about how to compute the timings. If not specified, it defaults to the closest authority based on the location or co-ordinates specified in the API call.
*/
method: calculationMethods;
/**
* Which Shafaq to use if the method is Moonsighting Commitee Worldwide. Defaults to 'general'.
*/
shafaq?: "general" | "ahmer" | "abyad";
/**
* Comma Separated String of integers to offset timings returned by the API in minutes. Example: 5,3,5,7,9,7. See https://aladhan.com/calculation-methods
*/
tune?: string;
/**
* If you leave this empty, it defaults to Shafii.
*/
school?: schoolTypes;
/**
* If you leave this empty, it defaults to Standard.
*/
midnightMode?: midnightModes;
/**
* Method for adjusting times higher latitudes - for instance, if you are checking timings in the UK or Sweden.
*/
latitudeAdjustmentMethod?: latitudeAdjustmentMethods;
/**
* Number of days to adjust hijri date(s). Example: 1 or 2 or -1 or -2
*/
adjustment?: 1 | 2 | -1 | -2;
/**
* Whether to return the prayer times in the iso8601 format. Example: true will return 2020-07-01T02:56:00+01:00 instead of 02:56
*/
iso8601?: boolean;
}interface baseResponse<T> {
code: number;
status: string;
data: T;
}type getCalendarResponse = baseResponse<calendarData[]>;
interface calendarData {
timings: {
Fajr: string;
Sunrise: string;
Dhuhr: string;
Asr: string;
Sunset: string;
Maghrib: string;
Isha: string;
Imsak: string;
Midnight: string;
};
date: {
readable: string;
timestamp: string;
gregorian: calendarDataDate<"greg">;
hijri: calendarDataDate<"hijri">;
};
meta: calendarDataMeta;
}
type calendarDataDate<T extends string> = {
date: string;
format: string;
day: string;
year: string;
designation: {
abbreviated: string;
expanded: string;
};
} & T extends "hijri"
? {
weekday: { en: string; ar: string };
month: { number: number; en: string; ar: string };
holidays: string[];
}
: {
weekday: { en: string };
month: { number: number; en: string };
};
interface calendarDataMeta {
latitude: number;
longitude: number;
timezone: string;
method: method;
latitudeAdjustmentMethod: string;
midnightMode: string;
school: string;
offset: {
Imsak: number;
Fajr: number;
Sunrise: number;
Dhuhr: number;
Asr: number;
Maghrib: number;
Sunset: number;
Isha: number;
Midnight: number;
};
}type getTimingsResponse = baseResponse<calendarData>;type getMethodsResponse = baseResponse<methods>;
type methods = Record<string, method>;
interface method {
id: number;
name: string;
params: {
Fajr?: number;
Isha?: number | string;
Maghrib?: number | string;
Midnight?: string;
shafaq?: string;
};
location: {
latitude: number;
longitude: number;
};
} Muhammad Assar |
If you enjoy working with TypeScript, we also recommend other libraries by the same author:
- ngx-hadeethenc-api - 🕋 🚀 Angular api client for hadeethenc.com
- @wursha/ngx-hadeethenc-api - npm package with built-in type declarations