JSPM – epfl-unit-api@4.0.1

Package Exports

epfl-unit-api
epfl-unit-api/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (epfl-unit-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

EPFL Unit API.

Install

npm i epfl-unit-api --save

Usage

const epflUnitApi = require('epfl-unit-api');

epflUnitApi.findUnitByName('mws').then((unit) => {
  console.log(unit.code);      // => 13033
  console.log(unit.name);      // => 'Middleware Services'
  console.log(unit.unitPath);  // => 'EPFL VPO VPO-SI ITOP ITOP-MWS'
}).catch((err) => {
  console.log(err);
});

epflUnitApi.findUnitByCode(13030, 'en').then((unit) => {
  console.log(unit.acronym);   // => 'ISAS-FSD'
  console.log(unit.name);      // => 'Full-Stack Development'
  console.log(unit.unitPath);  // => 'EPFL VPO VPO-SI ISAS ISAS-FSD'
}).catch((err) => {
  console.log(err);
});

API

.findUnitByName(unit, language)

Type: function

Returns a Promise with the unit as parameter.

unit

Type: string

The name of an EPFL unit.

language

Type: string
Default: en

Supported languages are English (en) and French (fr).

.findUnitByCode(code, language)

Type: function

Returns a Promise with the unit as parameter.

code

Type: number

The code of an EPFL unit.

language

Type: string
Default: en

Supported languages are English (en) and French (fr).

Contributing

Contributions are always welcome.

See Contributing.

Developer

William Belle

License

Apache License 2.0

See the LICENSE file for more details.