Have ideas to improve npm?Join in the discussion! »

    nusmoderator
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    NUSModerator

    A lightweight library with helpful functions for NUS-related matters.

    Installation

    npm i nusmoderator -S
    # or if you use yarn: 
    yarn add nusmoderator

    API

    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

    • acadYear the 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

    Returns Object acadYearObject - { year: "15/16", startDate: Date }

    getAcadSem

    Computes the current academic semester. Expects a week number of a year.

    Parameters

    Examples

    acadWeekNumber(3)

    Returns string semester - "Semester 1"

    getAcadWeekName

    Computes the current academic week of the semester Expects a week number of a semester.

    Parameters

    Examples

    acadWeekNumber(3)

    Returns string semester - "Recess" | "Reading" | "Examination"

    getAcadWeekInfo

    Computes the current academic week and return in an object of acad date components

    Parameters

    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

    Install

    npm i nusmoderator

    DownloadsWeekly Downloads

    29

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    38 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar