API Reference

Table of Contents

• StaticCalculator
  • Constructor
  • Methods
• ReactiveCalculator
  • Constructor
  • Methods
• Helper Functions
  • calculateQibla
• Types
  • CoordinatesObject
  • TimeObject

StaticCalculator

Constructor

new StaticCalculator(config: CalculationsConfig)

Initializes a new StaticCalculator instance.

Parameters:

• config: CalculationsConfig

Example:

const calculator = new StaticCalculator({
  /* config options */
})

Methods

getQiblaDirection(coordinates?: CoordinatesObject): number

Calculates the Qibla direction.

Parameters:

• coordinates: Optional. CoordinatesObject

Example:

const direction = calculator.getQiblaDirection()

ReactiveCalculator

Constructor

new ReactiveCalculator(config: CalculationsConfig)

Initializes a new ReactiveCalculator instance.

Methods

cleanup(): void

Cleans up all subscriptions.

Example:

reactiveCalculator.cleanup()

Helper Functions

calculateQibla

calculateQibla(coordinates: CoordinatesObject): number

Calculates the Qibla direction based on the given coordinates.

Example:

const direction = calculateQibla({ latitude: 40.7128, longitude: -74.006 })

Types

CoordinatesObject

{
  latitude: number
  longitude: number
}

TimeObject

{
  name: string
  time: Date
}