PrayTime is a lightweight and flexible JavaScript library for calculating prayer times.

This manual provides a guide on how to use the library in web pages and JavaScript-based applications.

• praytime.js (v3.1) [‌5KB minified]
• Get from GitHub or npm
• See changes log

• A simple example: daily.html
• Monthly timetable: monthly.html
• Yearly prayer times: yearly.html

PrayTime is designed to work both in browser and in Node.js.

<script src="praytime.js"></script>
<script>
    const praytime = new PrayTime();
    praytime.times();
</script>

You can also load the js file directly from a CDN.

npm install praytime

const { PrayTime } = require('praytime');
 
const praytime = new PrayTime();
praytime.times();

The output of praytime.times() in both examples above is a JavaScript object with the following structure:

{
  fajr: '05:03',
  sunrise: '06:21',
  dhuhr: '12:27',
  asr: '15:53',
  sunset: '18:34',
  maghrib: '18:35',
  isha: '19:52',
  midnight: '00:27'
}

The PrayTime library offers a range of functions to customize calculation parameters, as detailed below. To test the sample code snippets, simply open your browser's console and execute them.

The default calculation method used in PrayTime is Muslim World League (MWL). You can change the calculation method using the following function:

method(method)

The method parameter is a string that can be set to any of the followings:

More information on the above calculation methods is provided here. You can also add dew calculation methods to the library if needed.

Example

praytime.method('ISNA');

Note: You can set the calculation method upon initializing the praytime object.

const praytime = new PrayTime('ISNA');

The following function is used to set location:

location(coordinates)

The coordinates should be provided as an array [latitude, longitude]. The latitude is a real number between -90 and 90, while the longitude ranges from -180 to 180.

Example

praytime.location([43, -80]);

To set timezone, we can use the following function:

utcOffset(utcOffset)

The utcOffset parameter is a real number representing the difference from Greenwich Mean Time (GMT) in hours or minutes. If not provided or set to 'auto', the utcOffset is automatically determined based on the system's time settings.

For time zones like +3:30, the utcOffset parameter can be entered as 3.5. For daylight saving time, simply add 1 to the utcOffset.

Example

praytime.utcOffset(-5);

Note: It is recommended to use a modern library such as luxon for dealing with timezones.

To retrieve prayer times, use the following function:

times(date)

The date parameter can be in any of the following types:

If no date is provided, the function defaults to the system's current date.

The output of times function is an object containing 8 prayer times (see here for the list of times and their definition). Each time can be accessed through its name. For example, if the output of times function is stored in an object times, the time for sunrise can be accessed through times.sunrise.

Example

const times = praytime.times()
console.log('Sunset : ' + times.sunset)

Note: PrayTime has a chainable API, allowing you to set multiple parameters at once, before calling the final times method. An example is provided below.

praytime.method('ISNA').location([43, -80]).utcOffset(-5).times();

the returned prayer times are formatted as a 24-hour string by default. To customize the time format, you can use the following function:

format(format)

The format parameter can be any of the followings:

Example

praytime.format('12h').times()

The calculating parameters can be adjusted using the following function:

adjust(parameters)

parameters is an object composed of any number of the following parameters:

Example

praytime.adjust( {fajr: 16, dhuhr: '5 min', asr: 'Hanafi', isha: 15} );

You can further tune calculated prayer times (for precaution) using the following function:

tune(offsets)

where offsets is an associative array containing time offsets in minutes for each prayer time.

Example

praytime.tune( {sunrise: -1, sunset: 3.5} );

By default, PrayTime rounds minutes to the nearest values. To round the times in different way, you can use the following function.

round(method)

where method parameter can be any of the followings:

Example

praytime.round('up');

You can get the list of calculation methods available in PrayTime via praytime.methods object.

console.log(praytime.methods);

The output will be as follows.

{
  MWL: { fajr: 18, isha: 17 },
  ISNA: { fajr: 15, isha: 15 },
  Egypt: { fajr: 19.5, isha: 17.5 },
  Makkah: { fajr: 18.5, isha: '90 min' },
  Karachi: { fajr: 18, isha: 18 },
  Tehran: { fajr: 17.7, maghrib: 4.5, midnight: 'Jafari' },
  Jafari: { fajr: 16, maghrib: 4, midnight: 'Jafari' },
  defaults: { isha: 14, maghrib: '1 min', midnight: 'Standard' }
}

Note that defaults parameters are applied to all methods.

You can add new calculation methods to the list of calculation methods available in PrayTime as follows.

praytime.methods['France'] = { fajr: 12, isha: 12 };
praytime.methods['Singapore'] = { fajr: 20, isha: 18 };

You can then use the new calculation methods like other methods available in PrayTime:

praytime.method('France');

• How are prayer times determined?
• See all versions of PrayTime code