README.md

Install

Install with npm

$ npm install academic-year --save

Initial

Set the first day of academic year, requires ISO 8601 string in date part.

var AcademicYear = require('academic-year');
// new AcademicYear(FIRSTDATE, ENDDATE)
var schoolAcademicYear = new AcademicYear('2015-09-01', '2016-06-30'); 

Usage

Basic Academic year

console.log(schoolAcademicYear.getCurrent());
console.log(schoolAcademicYear.getCurrentAbbr());
console.log(schoolAcademicYear.getNext());
console.log(schoolAcademicYear.getNextAbbr());

// 2015
// 15
// 2016
// 16

Academic year name - Return different academic year format

console.log('Id 1: ' + schoolAcademicYear.getId());
console.log('Id 2: ' + schoolAcademicYear.getId(''));	
console.log('Name 1: ' + schoolAcademicYear.getName());
console.log('Name 2: ' + schoolAcademicYear.getName('/'));	
console.log('Name 3: ' + schoolAcademicYear.getAbbrName());
console.log('Name 4: ' + schoolAcademicYear.getAbbrName('*'));	

// Id 1: 15-16
// Id 2: 1516
// Name 1: 2015-2016
// Name 2: 2015/2016
// Name 3: 2015-16
// Name 4: 2015*16

Total school days

var schoolAcademicYear = new AcademicYear('2016-09-01', '2017-06-30'); 
console.log('School days (Include end date): ' + schoolAcademicYear.getSchoolDays());
console.log('School days (Exclude end date)' + schoolAcademicYear.getSchoolDays(false));

// 334
// 333