Skip to main content

@lehuyh/assist-js@0.1.2

An unofficial JavaScript library for fetching class articulation agreements between schools from ASSIST.org

Works with
This package works with Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
JSR Score
100%
Published
3 weeks ago
deno add @lehuyh/assist-js
import * as mod from "@lehuyh/assist-js";
npx jsr add @lehuyh/assist-js
import * as mod from "@lehuyh/assist-js";
yarn dlx jsr add @lehuyh/assist-js
import * as mod from "@lehuyh/assist-js";
pnpm dlx jsr add @lehuyh/assist-js
import * as mod from "@lehuyh/assist-js";
bunx jsr add @lehuyh/assist-js
import * as mod from "@lehuyh/assist-js";

🏫 ASSIST JS

MIT License JSR Version

An unofficial JavaScript library for fetching class articulation agreements between schools from ASSIST.org

Quick Start

import { fetchAgreementsByMajor } from '@lehuyh/assist-js';

const agreements = await fetchAgreementsByMajor({
    year: 2024,
    fromSchoolID: 18, // Las Positas College
    toSchoolID: 21 // CSU East Bay
})

//Print out agreements grouped by major
console.log(majors)

Installation

Assist JS supports all major package managers vis JSR.

NPM

npx jsr add @lehuyh/assist-js

Yarn

yarn dlx jsr add @lehuyh/assist-js

Deno

npx jsr add @lehuyh/assist-js

To view all available package managers and installation instructions, visit the JSR package page.

API Reference

fetchAllAgreements(options)

Fetch ALL class articulation agreements between two schools

  fetchAllAgreements({ year, fromSchoolID, toSchoolID })
Parameter Type Description
year number Required. The year of the agreements
fromSchoolID string Required. The ID of the school from which the agreements are made
toSchoolID string Required. The ID of the school to which the agreements are made

fetchAgreementsByMajor(options)

Fetch class articulation agreements between two schools grouped by major

  fetchAgreementsByMajor({ year, fromSchoolID, toSchoolID })
Parameter Type Description
year number Required. The year of the agreements
fromSchoolID string Required. The ID of the school from which the agreements are made
toSchoolID string Required. The ID of the school to which the agreements are made

Utility API Reference

These functions are used internally by the main functions but are exposed if you want to create your own custom functions.

createAssistArticulationURL(options)

For use with fetchAssistArticulationURL(url)

  createAssistArticulationURL({ year, fromSchoolID, toSchoolID })
Parameter Type Description
year number Required. The year of the articulation
fromSchoolID string Required. The ID of the school from which the articulation is made
toSchoolID string Required. The ID of the school to which the articulation is made

createAssistArticulationURLFromKey(key)

For use with fetchAssistArticulationURL(url)

  createAssistArticulationURLFromKey(key: string)
Parameter Type Description
key string Required. Key to create URL from

fetchAssistArticulationURL(url)

Fetches and organizes data from ASSIST.org agreements API

  fetchAssistArticulationURL(url: string)
Parameter Type Description
url string Required. URL to fetch data from

fetchMajors(options)

Fetches the major agreements between two schools. This only returns major information NOT class articulation agreements.

  fetchMajors({ year, fromSchoolID, toSchoolID })
Parameter Type Description
year number Required. The year of the major agreements
fromSchoolID string Required. The Assist ID of the school from which the major agreements are being fetched
toSchoolID string Required. The Assist ID of the school to which the major agreements are being fetched

Author

License

MIT