Documentation GitHub YouTube

Module

Module

Members

Object.<Sequelize.models>

# inner constant models

Sequelize models

View Source api/interfaces/Module.js, line 12

Methods

# async inner add(newModule) → {Promise.<APIResp>}

Add a new module

Parameters:
Name Type Description
newModule NewModule

View Source api/interfaces/Module.js, line 71

APIError
Promise.<APIResp>

# async inner addFromETL(newModule) → {Promise.<APIResp>}

Add a new module from etl

Parameters:
Name Type Description
newModule NewModuleFromETL

View Source api/interfaces/Module.js, line 98

Promise.<APIResp>

# async inner getAll(filtersopt) → {Promise.<APIResp>}

Get all modules

Parameters:
Name Type Attributes Description
filters ModuleFilters <optional>

View Source api/interfaces/Module.js, line 125

Promise.<APIResp>

# async inner getByID(moduleID) → {Promise.<APIResp>}

Get one module by its id

Parameters:
Name Type Description
moduleID number

View Source api/interfaces/Module.js, line 166

APIError
Promise.<APIResp>

# async inner getNotesByUserID(userID, filters) → {Promise.<APIResp>}

Get all modules with notes of a user

Parameters:
Name Type Description
userID number
filters ModuleNotesFilters

View Source api/interfaces/Module.js, line 187

Promise.<APIResp>

Type Definitions

Object

# ModuleFilters

Properties:
Name Type Description
years array.<number>

View Source api/interfaces/Module.js, line 47

Object

# ModuleNotesFilters

Properties:
Name Type Description
years array.<number>

View Source api/interfaces/Module.js, line 41

Object

# NewModule

Properties:
Name Type Description
year number
name string
long_name string
ects number

View Source api/interfaces/Module.js, line 20

Object

# NewModuleFromETL

Properties:
Name Type Description
id number
moduleId string
moduleName string
moduleDescription string
year number
credits number
cursus string

View Source api/interfaces/Module.js, line 29