Chulalongkorn University's Course Utility Library for TypeScript

Table of Contents

• Installation
• Related Projects
• Usage
  • Functions
  • Utilities
• Schemas

Installation

# with npm
npm install @thinc-org/chula-courses

# with yarn
yarn install @thinc-org/chula-courses

Related Projects

For CU Get Reg's website

• @thinc-org/cugetreg-frontend

For CU Get Reg's API server

• @thinc-org/cugetreg-backend

For scraping Reg Chula courses

• @thinc-org/cugetreg-scraper

For storing scraped Reg Chula courses

• @thinc-org/chula-courses-data

Usage

This repository provides utility functions and types for @thinc-org/chula-courses-data

Fetching

getCourses() to fetch course data. timeout is the maximum request time for fetching course data; 100 seconds by default. You can also fetch mock data by using getMockCourses().

getCourses(time:number): Promise<Course[]>

getMockCourses(time:number): Promise<Course[]>

downloadCourses() to download course data. fileName is ./courses.json by default. You can also download mock data by using downloadMockCourses().

downloadCourses(fileName:string): Promise<void>

downloadMockCourses(fileName:string): Promise<void>

Utilities

isValidTime() to check that the giving time is valid. The time should be formatted as hh:mm, for example 00:00 and 13:45.

isValidTime(time: string): boolean

isValidPeriod() to check that the giving period is valid.

isValidPeriod(period: Period): boolean

isValidExamPeriod() to check that the giving examPeriod is valid.

isValidExamPeriod(examPeriod: ExamPeriod): boolean

Schema

You may find the schema's description here.