epfl-unit-api

4.0.0 • Public • Published

EPFL Unit API

EPFL Unit API.

Build Status Coverage Status Apache License 2.0 NPM Version


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

License

Apache License 2.0

(c) William Belle, 2019-2023.

See the LICENSE file for more details.

Package Sidebar

Install

npm i epfl-unit-api

Weekly Downloads

13

Version

4.0.0

License

Apache-2.0

Unpacked Size

15.6 kB

Total Files

4

Last publish

Collaborators

  • williambelle