nicholas-sliter / catalog.js

A JavaScript / TypeScript API for the Middlebury course catalog.

catalog.js

A JavaScript / TypeScript API for the Middlebury course catalog.

Install

$ npm install --save middlebury-catalog

This updated NPM module is ESM only and is compiled to modern ES6+ JS.

Examples

Scrape the course catalog for a given term in one of two formats (YYYYSS or SYY) and a set of search parameters. The URL is automatically constructed based on the term and parameters. If given no search parameters, the scraper will use its predefined defaults.

import Scraper from ('middlebury-catalog');

const scraper = new Scraper('202190');
const catalog = await scraper.getCatalog();
 

or manually

import Scraper from ('middlebury-catalog');

const scraper = new Scraper('F21');
await scraper.scrape();
await scraper.parse();
const catalog = scraper.catalog;

Specify an XML file to scrape from.

import Scraper from ('middlebury-catalog');

const scraper = new Scraper('F21', searchParameters);
const catalog = await scraper.getCatalogFromFile("./test/test.xml");

Develop

Clone the repository then run:

$ npm install

Run the tests with:

$ npm test