Getting Started ​

Overview ​

prayers-call is a TypeScript library for calculating Islamic prayer times, built with reactivity in mind it's compatible with both Node.js and browser environments.

For insights into the motivation and features of this project, visit the Why prayers-call section.

Trying prayers-call online ​

Experience prayers-call without any installation via our StackBlitz Playground. This browser-based environment closely mimics a local setup, allowing you to test the library's features effortlessly.

Adding prayers-call to Your Project ​

You have multiple options for integrating prayers-call into your project:

Package Managers ​

Install using npm, yarn, pnpm, or bun:

npm ​

npm i prayers-call

npm i prayers-call

yarn ​

yarn add prayers-call

yarn add prayers-call

pnpm ​

pnpm add prayers-call

pnpm add prayers-call

bun ​

bun add prayers-call

bun add prayers-call

CDN ​

Include prayers-call via a CDN by adding the following script tag to your HTML:

<script src="https://unpkg.com/prayers-call/dist/index.cjs"></script>

<script src="https://unpkg.com/prayers-call/dist/index.cjs"></script>

We are using unpkg in this example, but other CDNs like jsdelivr or cdnjs works as well. Alternatively, you can download and serve the file yourself.

Deno ​

For Deno users, prayers-call is available on deno.land/x. Import the latest version or a specific version as follows:

Latest Version: ​

import { StaticCalculator } from 'https://deno.land/x/prayers'

import { StaticCalculator } from 'https://deno.land/x/prayers'

Specific Version: ​

import { StaticCalculator } from 'https://deno.land/x/prayers@v1.1.0'

import { StaticCalculator } from 'https://deno.land/x/prayers@v1.1.0'

Basic Usage ​

Here's a quick example to get you started with the StaticCalculator for one-time prayer time calculations:

import { Methods, StaticCalculator } from 'prayers-call'

const calculator = new StaticCalculator({
  date: new Date(), // today
  latitude: 21.42251,
  longitude: 39.826168,
  method: Methods.UMMU_AL_QURA,
})

const prayerTimes = calculator.getPrayerTimes()
console.log(prayerTimes)

import { Methods, StaticCalculator } from 'prayers-call'

const calculator = new StaticCalculator({
  date: new Date(), // today
  latitude: 21.42251,
  longitude: 39.826168,
  method: Methods.UMMU_AL_QURA,
})

const prayerTimes = calculator.getPrayerTimes()
console.log(prayerTimes)