majusss/timetable-parser-js

VULCAN Optivum Timetable parser for JS

Forked from dzienniczkowy/timetable-parser-js

Installation

Via PNPM

pnpm install @majusss/timetable-parser

Usage

Parsing Timetable Index Page

import { Timetable } from "@majusss/timetable-parser";

const timetable = new Timetable(/*Content of index.html file*/);

// Returns: String containing title of the timetable
const title = timetable.getTitle();

// Returns: String containing path to lista.html file
const list = timetable.getListPath();

Parsing Timetable List

import { TimetableList } from "@majusss/timetable-parser";

const timetableList = new TimetableList(/*Content of lista.html file*/);

// Returns: Object of 3 lists
const list = timetableList.getList();

// Returns: String containing path to school logo
const logo = timetableList.getLogoSrc();

Parsing Table

import { Table } from "@majusss/timetable-parser";

const table = new Table(/*Content of plany/XYY.html file*/);

// Returns: String containing title of the timetable
const title = table.getTitle();

// Returns: Array of days from timetable headers
const dayNames = table.getDayNames();

// Returns: Object of hours
const hours = table.getHours();

// Returns: Array of lessons sorted by lesson number
const rawDays = table.getRawDays();

// Returns: Array of lessons sorted by days
const days = table.getDays();

// Returns: String containing timetable generation date
const generated = title.getGeneratedDate();

// Returns: String containing timetable effective date
const generated = title.getVersionInfo();