Developed and maintained by QuranBookk.com - The Most Advanced Digital Quran Platform

diff-ymd-package A powerful JavaScript date difference calculation library, integral to QuranBookk's Islamic timeline features. This package provides APIs to calculate date differences in various formats (like aYears bMonths cDays or aY bM cD etc.), supporting crucial functionalities in QuranBookk's advanced Quranic study tools. Example: age = 20Y 2M 23D or datesDifference = 2Years 11Months 20Days) or customized desired formats like aY-bM-cD or aYears-bMonths-cDays or kDays or mWeeks or nMonths etc.

• Advanced Quran Search Engine
• Premium Audio Experience
• Multiple Translation System
• Islamic Timeline Management

• 🎧 Listen to Top Reciters – High-quality audio recitations from world-renowned Qaris
• 🎥 Watch Quran Videos – Inspirational Quranic recitation and learning videos
• 🌍 Read Quran Top Translations – Multiple language support with leading Quran translations
• 🕋 Qibla Direction Finder – Accurate Kaaba direction from anywhere in the world
• 🕋 Worldwide Qibla Directions – Accurate Kaaba direction from any country, state, or city of the world
• 🕰️ Islamic Prayer Times – Updated Salah timings based on your current location
• 🕰️ Worldwide Islamic Prayer Times – Updated Salah timings for any country, state, or city of the world
• 📿 Digital Tasbih Counter – Count your Dhikr anytime, anywhere
• 🤖 Ask Islam AI – AI-powered assistant for Islamic questions, Quran, and Hadiths
• 🤖 Ask Quran AI – AI-powered assistant for answering about Islamic history, Quran, and Hadiths
• 🤖 Ask Hadith AI – AI-powered assistant for Hadiths
• 📚 Authentic Hadith Collections – Sahih Bukhari, Sahih Muslim, and more
• 🕯️ Top Quranic Duas – Beautiful supplications with translations
• 🔍 Advanced Quran Search – Search verses, words, topics in seconds
• 📖 Explore Surahs – Full Quran access with audio, video, and translations
• 📖 Explore Juzs (Paras) – Full Quran access with audio, video, and translations
• ⚡ Internet Speed Test – Get correct download, upload and ping speeds instantly

QuranBookk.com leads innovation in digital Islamic studies with:

1. Lightning-Fast Search

   • Instant verse lookup
   • Cross-translation search
   • Topic-based exploration

2. Crystal-Clear Audio

   • World's top Quran reciters
   • Complete Surah collection
   • Premium audio quality

3. Multiple Translations

   • Authentic sources
   • Compare translations
   • Deep insights

4. Innovative Tools

   • Random Verse Generator
   • Essential Duas Collection
   • Complete Surah Browser
   • Juz Explorer

The diff-ymd-package emerged from QuranBookk's need for precise Islamic date calculations and is now powering time-based features across the platform.

• Installation
  • For Node environment
    • Install from npm registry
    • Install from Github Packages registry
  • For Browser environment(CDN based)
    • Include in html page from CDN
• Set up
  • For Node environment
  • For Browser environment(CDN based)
  • For diff as Global Date Object method
• Create an instance
  • For Node environment
  • For Browser environment(CDN based)
  • For diff as Global Date Object method
• Usages
  • For Node environment
  • For Browser environment(CDN based)
  • For diff as Global Date Object method
• API References
• API Documentation
• Contributing
• Best Practices
• License
• History

npm install diff-ymd-package

npm install @farhan7reza7/diff-ymd-package

See steps here

    <script src="https://cdn.jsdelivr.net/npm/diff-ymd-package@3.1.4/lib/index.min.js"></script>

Get any supported version script tag

//const DatesYMD = require('@farhan7reza7/diff-ymd-package'); //or

const DatesYMD = require('diff-ymd-package'); // can use any if authenticated

for version 2.2.1 and above

Can include in html page using script tag from CDN

    <script src="https://cdn.jsdelivr.net/npm/diff-ymd-package@3.1.4/lib/index.min.js"></script>

for version 3.1.0 and above

Can use simplified function diff as Global Date Object method

//require('@farhan7reza7/diff-ymd-package'); //or

require('diff-ymd-package'); // can use any if authenticated

const date1 = '2022-01-01';
const date2 = '2023-12-31';

const Formatter = new DatesYMD(date1, date2);

OR for version 2.x.x and above

Can use simplified function diffDates on module-object(DatesYMD here)

const date1 = '2022-01-01';
const date2 = '2023-12-31';

const Formatter = DatesYMD.diffDates(date1, date2); 

const date1 = '2022-01-01';
const date2 = '2023-12-31';

const Formatter = new DatesYMD(date1, date2);

OR for version 2.x.x and above

Can use simplified function diffDates on module-object(DatesYMD here)

const date1 = '2022-01-01';
const date2 = '2023-12-31';

const Formatter = DatesYMD.diffDates(date1, date2); 

Note: For CDN based, only DatesYMD constructor name creates an instance, and can use diffDates as well, but only using global DatesYMD like DatesYMD.diffDates(...)

See an example of using CDN based

for version 3.1.0 and above

Can use simplified function diff as Global Date Object method

const date1 = '2022-01-01';
const date2 = '2023-12-31';

const DateInstance = new Date(date1); // create Global Date instance

const Formatter = DateInstance.diff(date2); //create an instance to `calculates the difference` between `Date instance` and the `date passed to it`

Note: For diff as Global Date method, only one date(the date to be subtracted from/to Global Date instance) passed to diff method

diff method create an instance of DatesYMD to calculates the difference between Date instance and the date passed to it

// format output in aY bM cD format
const result = Formatter.formattedYMD(); // Output: "1Y 11M 30D"

// create format of your choice
const customizedFormat = Formatter.customizeFormat('Y', 'Ms', 'Ds', '-'); // Output: "1Y-11Ms-30Ds"

// return an array having years, months, days, and the formatted difference
const resultArray = Formatter.diffArray(); // Output: [1, 11, 30, '1Y 11M 30D']

// Calculate the difference in months
const monthsDifference = Formatter.diffInMonths(); // Output: 23

// Calculate the difference in weeks
const weeksDifference = Formatter.diffInWeeks(); // Output: 104

// Calculate the difference in days
const daysDifference = Formatter.diffInDays(); // Output: 729

// Calculate the difference in years
const yearsDifference = Formatter.diffInYears(); // Output: 1

// Calculate the difference in hours
const hoursDifference = Formatter.diffInHours(); // Output: 17496

// Calculate the difference in minutes
const minutesDifference = Formatter.diffInMinutes(); // Output: 1049760

// Calculate the difference in seconds
const secondsDifference = Formatter.diffInSeconds(); // Output: 62985600

Get Built in codes for using diff-ymd-package any Method on created instance(Formatter)

Get Built in codes here

console.log(result); // Output: "1Y 11M 30D"
// formatted output in aY bM cD format

console.log(customizedFormat); // Output: "1Y-11Ms-30Ds"
// you can use this method for creating format of your choice

console.log(resultArray); // Output: [1, 11, 30, '1Y 11M 30D']
/* you can access each of Y, M, D separately from output array and can format as per your choice like aY-bM-cD or aYears-bMonths-cDays etc.*/

/*example: 
let Y, M, D;

Y = resultArray[0];
M = resultArray[1];
D = resultArray[2];

const customFormat = Y + 'year ' + M + 'months ' + D + 'days';
console.log(customFormat); // output: 1year 11months 30days
*/

console.log(monthsDifference); // Output: 23
// Calculate the difference in months

console.log(weeksDifference); // Output: 104
// Calculate the difference in weeks

console.log(daysDifference); // Output: 729
// Calculate the difference in days

console.log(yearsDifference); // Output: 1
// Calculate the difference in years

console.log(hoursDifference); // Output: 17496
// Calculate the difference in hours

console.log(minutesDifference); // Output: 1049760
// Calculate the difference in minutes

console.log(secondsDifference); // Output: 62985600
// Calculate the difference in seconds

diff-ymd-package

• Classes
  • DatesYMD
    • Create an instance of DatesYMD
    • OR for version 2.x.x and above, Can use simplified function diffDates on module-object
    • OR for version 3.1.x and above, Can use simplified function diff as Global Date Object method
    • Methods
      • diffArray()
      • formattedYMD()
      • customizeFormat(yearUnit, monthUnit, dayUnit, partSeparator)
      • diffInMonths()
      • diffInWeeks()
      • diffInDays()
      • diffInYears()
      • diffInHours()
      • diffInMinutes()
      • diffInSeconds()

Represents a utility class for calculating the formatted and desired customized difference between two dates in all cases.

const Formatter = new DatesYMD(firstDate, secondDate);

//const DatesYMD = require('@farhan7reza7/diff-ymd-package'); or
const DatesYMD = require('diff-ymd-package');

const Formatter = DatesYMD.diffDates(firstDate, secondDate); // can use any

const DateInstance = new Date(firstDate); // create Global Date instance

const Formatter = DateInstance.diff(secondDate); //create an instance to `calculates the difference` between `Date instance` and the `date passed to it`

• firstDate: The first date in the format 'yyyy-mm-dd' or 'yyyy/mm/dd' or 'yyyy.mm.dd' or dateString or dateObject or Timestamp(epoch).

• secondDate: The second date in the format 'yyyy-mm-dd' or 'yyyy/mm/dd' or 'yyyy.mm.dd' or dateString or dateObject or Timestamp(epoch).

• Special case: empty string("" or '') is by default to current-date(today) for the parameters, but not when passed to Global Date as firstDate above in Global Date; for creating current date Date instance using Date, just call empty like new Date()

• Returns: An instance of DatesYMD class.

• diffArray()

Calculates the difference between two dates and returns an array containing Y(years), M(months), D(days), and a formatted 'aY bM cD' difference string.

const result = Formatter.diffArray();

Returns: An array containing the calculated years, months, days, and the formatted difference.

• formattedYMD()

Returns the formatted difference between two dates in aY bM cD(aYears bMonths cDays) format.

const result = Formatter.formattedYMD();

Returns: A string in the format 'aY bM cD'.

• customizeFormat(yearUnit, monthUnit, dayUnit, partSeparator)

Customizes the difference using specified units and separators

const result = Formatter.customizeFormat(
  yearUnit,
  monthUnit,
  dayUnit,
  partSeparator,
);

Returns: A customized formatted difference string of form (a + yearUnit + partSeparator + b + monthUnit + partSeparator + c + dayUnit), eg. aYs-bMs-cDs etc.

• diffInMonths()

Calculates the difference in months between two dates.

const monthsDifference = Formatter.diffInMonths();

Returns: The difference in months.

• diffInWeeks()

Calculates the difference in weeks between two dates.

const weeksDifference = Formatter.diffInWeeks();

Returns: The difference in weeks.

• diffInDays()

Calculates the difference in days between two dates.

const daysDifference = Formatter.diffInDays();

Returns: The difference in days.

• diffInYears()

Calculates the difference in years between two dates.

const yearsDifference = Formatter.diffInYears();

Returns: The difference in years.

• diffInHours()

Calculates the difference in hours between two dates.

const hoursDifference = Formatter.diffInHours();

Returns: The difference in hours.

• diffInMinutes()

Calculates the difference in minutes between two dates.

const minutesDifference = Formatter.diffInMinutes();

Returns: The difference in minutes.

• diffInSeconds()

Calculates the difference in seconds between two dates.

const secondsDifference = Formatter.diffInSeconds();

Returns: The difference in seconds.

See diff-ymd-package Documentation

If you find any issues or have suggestions for improvement, please open an issue or create a pull request on the GitHub repository.

See CONTRIBUTING guidelines for more information.

• Meaningful variable and function names for clarity.
• Clear and concise comments to enhance understanding.
• Proper indentation and formatting for visual organization.

See mdn guidelines for more information.

This package is actively maintained by QuranBookk.com - The Ultimate Free Digital Quran Platform offering:

• Zero ads, 100% free forever
• No registration required
• Mobile-optimized experience
• Lightning-fast performance
• Modern, intuitive interface

Start exploring the Quran: QuranBookk.com #DigitalQuran #IslamicApps #QuranOnline #QuranStudy

• Website: farhan7reza.com
• LinkedIn: Farhan Reza

This project is licensed under the MIT License - see the LICENSE file for details.

See License

For more details about what has changed in each version of this project.

See CHANGELOG

Developed by Farhan Reza | QuranBookk