# ualbany-course-api

> Simple library to retrieve dynamic data from the UAlbany Course webpage.

Latest version **1.0.1** (published 2019-06-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install ualbany-course-api
pnpm add ualbany-course-api
yarn add ualbany-course-api
bun add ualbany-course-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-06-09 |
| First published | 2019-06-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anson Foong |
| Maintainers | arcsty |

## Links

- npm: https://www.npmjs.com/package/ualbany-course-api
- Repository: https://github.com/ansonfoong/UAlbany-Course-API
- Homepage: https://github.com/ansonfoong/UAlbany-Course-API#readme
- Issues: https://github.com/ansonfoong/UAlbany-Course-API/issues
- npm.io page: https://npm.io/package/ualbany-course-api

## Recent versions

- 1.0.1 (latest) — 2019-06-09
- 1.0.0 — 2019-06-09

## README

# UAlbany-Course-API

Simple library to retrieve dynamic data from the UAlbany Course webpage.

# Installation

`npm i ualbany-course-api`

# Basic Example

```JS
const course = require('ualbany-course-api');
// Retrieve CSI 333
course.request('csi', 333)
.then(res => console.log(res))
.catch(err => console.log(err));

// Retrieve all CSI courses.
course.request('csi')
.then(res => console.log(res))
.catch(err => console.log(err));
```

# Documentation

## Methods
### **request(subject, code)**

 fetches all entries of the course followed by the subject/code

- **Parameters**
  - subject - the subject abbreviation for the course, e.g: CSI = Computer Science, MAT/AMAT = Mathematics
  - code - the course code, e.g: 333

- **Returns**
  - Array<Course> - an array of Course objects.
  
## Classes

TBA, it's just JSON, there are no methods.

---
_Source: https://npm.io/package/ualbany-course-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._