badicaljs v1.0.0

BadiCalJS

Library to convert between Gregorian and Badi / Bahai calendars.

Previously at BadiCal but that repo is being split into individual languages in the BahaiCalendar group.

There are currently versions for:

• Javascript (this)
• PHP

As the Badi date starts at sunset, every conversion has two possibilities. Converting from Gregorian to Badi, you can get either the Badi date before sunset or after sunset for that Gregorian day; the former is the default. Converting from Badi to Gregorian, you can get either the Gregorian date before midnight or after midnight; the default is the latter.

For example, 2015-03-21 (Gregorian) converts to the end of 172-01-01 (Badi: Bahá 1, 172 ie. Naw Ruz) as the default, and optionally to the start of 172-01-02 (Badi). Consequently, 172-01-01 (Badi) converts to the start of 2015-03-21 (Gregorian) as the defauls, and optionally as the end of 2015-03-20 (Gregorian).

The default is always the daytime conversion.

The library uses precalculated NawRuz dates from http://wilmetteinstitute.org/wp-content/uploads/2014/11/Bahai-Dates-172-to-221-B-E-_UK-December-2014.pdf . Please report any errors (see BadiCal.NAWRUZ).

Loading

For websites, use BadiCal.js in the bundle folder.

NPM is TBA.

Usage

The usage is currently extremely simple. There are two static conversion functions which return BadiDate objects.

Gregorian to Badi

BadiCal.GregorianToBadi

• @param year - the Gregorian year
• @param month - the Gregorian month
• @param date - the Gregorian date
• @param startOf - OPTIONAL, default=FALSE whether the returned date is the Badi date ending on (TRUE, evening) or starting on (FALSE, daytime) this Gregorian date.

var badiDate = 
	BadiCal.GregorianToBadi(
		2015, //Gregorian year 
		3,    //Gregorian month
		21,   //Gregorian date,
		true  //TRUE = start of, FALSE/Omited = end of  
	);
console.log(badiDate.monthName() + ' ' + badiDate.day() + ', ' + badiDate.year());
console.log('Date type: ' + badiDate.type);

badiDate = 
	BadiCal.GregorianToBadi(
		2015, //Gregorian year 
		3,    //Gregorian month
		21,   //Gregorian date,
		false  //Note the difference
	);
console.log(badiDate.year() + '-' + badiDate.month(true /* add zero */) + '-' + badiDate.day(true /* add zero */));

Which outputs:

Baha 2, 172
Date type: BADI
172-01-01

Badi to Gregorian

BadiCal.BadiToGregorian

• @param year - the Badi year
• @param month - the Badi month
• @param date - the Badi date
• @param startsOn - OPTIONAL, default=FALSE whether the returned date is the Gregorian date that starts on (TRUE, evening) or ends on (FALSE, daytime) this Badi date.

var gregDate = 
	BadiCal.BadiToGregorian(
		172, //Badi year 
		1,    //Badi month
		1,   //Badi date,
		true  //TRUE = start of, FALSE/Omited = end of  
	);
console.log(gregDate.monthName() + ' ' + gregDate.day() + ', ' + gregDate.year());
console.log('Date type: ' + gregDate.type);

gregDate = 
	BadiCal.BadiToGregorian(
		172, //Badi year 
		1,    //Badi month
		1,   //Badi date,
		false  //Note the difference
	);
console.log(gregDate.year() + '-' + gregDate.month(true /* add zero */) + '-' + gregDate.day(true /* add zero */));

Which outputs:

March 20, 2015
Date type: GREGORIAN
2015-03-21

Date object

The BadiCal.BadiDate class has the following:

Methods

year(formatted) @param bool formatted - OPTIONAL, default=false will pad the output with a zero @return the year

month(formatted) @param bool formatted - OPTIONAL, default=false will pad the output with a zero @return the month

monthName() @return the name of the month according to the appropriate calendar

day(formatted) @param bool formatted - OPTIONAL, default=false will pad the output with a zero @return the day

Properties

type Either BadiCal.constants.GREGORIAN ('GREGORIAN') or BadiCal.constants.BADI ('BADI')

Static Values / Methods

BadiCal.constants.GREGORIAN: 'GREGORIAN', used for the BadiDate->type

BadiCal.constants.BADI: 'BADI', used for the BadiDate->type

BadiCal.constants.BADI_MONTHS: Array with names for Badi Calendar months (zero based). Includes Ayyam-i-Há.

BadiCal.getAyyamiha(badi_year): @param badi_year - The year in the Badi calendar @return BadiCal.BadiDate

Testing

You must have the BadiTest repository to test the library. Simple use test.js to run a test group from BadiTest by specifying the path to the test group file, like:

node test.js /path/to/BadiTest/Basic.json

Which currently results in:

Test Group: Basic
------------------
    Naw Ruz ...... success
    First day of Ridvan ...... success
    Ninth day of Ridvan ...... success
    Twelfth day of Ridvan ...... success
    Declaration of the Báb ...... success
    Ascension of Bahá'u'lláh ...... success
    Martyrdom of the Báb ...... success
    Day of the Covenant ...... success
    Ascension of 'Abdu'l-Bahá ...... success
    Ala 1st ...... success
    Failure Check ...... success
11 tests,  0 failures,  11 successes.