npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

course-api-wrapper

v1.0.2

Published

An asynchronous TypeScript wrapper for SFU's course API. This package is not endorsed or supported by SFU.

Downloads

22

Readme

Contributors Forks Stargazers Issues MIT License LinkedIn

About The Project

This project was made since there is no developed wrapper that I know of for SFU's API. The goal is to not simply return the JSON data from the API, but custom classes with useful methods.

Also, this package has zero runtime dependencies! The package.json file only has "devDependencies", and no "dependencies".

This project is not endorsed or supported by Simon Fraser University.

Getting Started

Install the package from npm: npm install course-api-wrapper

Usage

Example usage of this API wrapper are shown below. For more detail, including all the properties each class has, see the TypeDoc Documentation.

Note that the API wrapper functions are the default export, while classes returned by the API wrapper functions and types used by this API wrapper are named exports.

Full Basic Example

In a non-async environment:

import courseApiWrapper from 'course-api-wrapper';

courseApiWrapper
    .courseSection('cmpt', '120', 'd100', 2021, 'fall')
    .then((courseSection) => {
        console.log(courseSection);
    });

In an async environment:

import courseApiWrapper from 'course-api-wrapper';

(async () => {
    const courseSection = await courseApiWrapper.courseSection(
        'cmpt',
        '105w',
        'd100',
        2022,
        'fall',
    );
    console.log(courseSection);
})();

Wrapper Functions

Get a course:

const course = await courseApiWrapper.course('cmpt', '120', 2021, 'fall');

Get a course offering:

const courseSection = await courseApiWrapper.courseSection(
    'cmpt',
    '120',
    'd100',
    2021,
    'fall',
);

Course Class

For the examples, assume an instance of class Course (found in Course.ts) called course has been created.

Check if a course has a given section:

const hasSection = await course.hasSection('d100');

Get a section of a course:

const courseSection = await course.getSection('d100');

Get all course offering sections of a course:

const courseSections = await course.getSections();

Loop through all course offering sections of a course:

for await (const courseSection of course) {
    console.log(courseSection);
}

Contributing

Feel free to fork and create a pull request, or open an issue.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ewan Brinkman

Project Link: https://github.com/ewanbrinkman/sfu-course-api-wrapper

Acknowledgments

  • SFU's Course Outlines REST API documentation
    • https://www.sfu.ca/outlines/help/api.html