NUSModerator
A lightweight library with helpful functions for NUS-related matters.
Installation
npm i nusmoderator -S# or if you use yarn: yarn add nusmoderatorAPI
Table of Contents
getAcadYearStartDate
Returns a Date object of the first weekday of Week 0 of that academic year. Assumes Week 0 begins on the first Monday of August.
Parameters
acadYearthe academic year. E.g. "18/19"
Returns Date Start date of the academic year
getAcadYear
Takes in a Date and returns an object of acad year and start date for that year.
Parameters
dateDate
Returns Object acadYearObject - { year: "15/16", startDate: Date }
getAcadSem
Computes the current academic semester. Expects a week number of a year.
Parameters
acadWeekNumbernumber
Examples
Returns string semester - "Semester 1"
getAcadWeekName
Computes the current academic week of the semester Expects a week number of a semester.
Parameters
acadWeekNumbernumber
Examples
Returns string semester - "Recess" | "Reading" | "Examination"
getAcadWeekInfo
Computes the current academic week and return in an object of acad date components
Parameters
dateDate
Returns Object { year: "15/16", sem: 'Semester 1'|'Semester 2'|'Special Sem 1'|'Special Sem 2', type: 'Instructional'|'Reading'|'Examination'|'Recess'|'Vacation'|'Orientation', num: }
getExamWeek
Get the first day of the exam week for the given semester
Parameters
Returns Date