DefinitelyTyped/types/adhan/index.d.ts

// Type definitions for adhan-js 3.0
// Project: https://github.com/batoulapps/adhan-js
// Definitions by: Ikramullah <https://github.com/skymunn>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

// UMD Module
export as namespace adhan;

// Declare method/property
export class PrayerTimes {
  constructor(coordinates: Coordinates, date: Date, params: Parameter);

  fajr: Date;
  sunrise: Date;
  dhuhr: Date;
  asr: Date;
  maghrib: Date;
  isha: Date;
}

export class Coordinates {
  constructor(longitude: number, latitude: number);
  longitude: number;
  latitude: number;
}

export const CalculationMethod: AdhanCalculationMethod;

export enum Madhab {
  Hanafi, Shafi
}

export enum HighLatitudeRule {
  MiddleOfTheNight, SeventhOfTheNight, TwilightAngle
}

export const Date: AdhanDate;

export const Math: AdhanMath;

// Declare Interface
export interface AdhanCalculationMethod {
  Dubai(): Parameter;
  Egyptian(): Parameter;
  Karachi(): Parameter;
  Kuwait(): Parameter;
  MoonsightingCommittee(): Parameter;
  MuslimWorldLeague(): Parameter;
  NorthAmerica(): Parameter;
  Other(): Parameter;
  Qatar(): Parameter;
  Singapore(): Parameter;
  UmmAlQura(): Parameter;
}

export interface Parameter {
  readonly method: string;
  fajrAngle: number;
  ishaAngle: number;
  ishaInterval: number;
  madhab: Madhab;
  highLatitudeRule: HighLatitudeRule;
  adjustments: {
    fajr: number;
    sunrise: number;
    dhuhr: number;
    asr: number;
    maghrib: number;
    isha: number;
  };
}

export interface AdhanDate {
  formattedTime(prayerTime: Date, offset?: number, style?: TimeMode): string;
  dateByAddingDays(date: Date, days: number): string;
  dateByAddingHours(date: Date, hours: number): string;
  dateByAddingMinutes(date: Date, minutes: number): string;
  dateByAddingSeconds(date: Date, seconds: number): string;
  dayOfYear(date: Date): string;
  julianDate(date: Date): string;
  roundedMinute(date: Date): string;
}

export interface AdhanMath {
  degreesToRadians(degrees: number): number;
  normalizeToScale(number: number, max: number): number;
  quadrantShiftAngle(angle: number): number;
  radiansToDegrees(radians: number): number;
  timeComponents(number: number): number;
  unwindAngle(angle: number): number;
}

// Declare type
export type TimeMode = '12h' | '24h';