API Documentation

Class

PreferredChoice

api/degree-plan.PreferredChoice(choices, interestIDs)

Class that can calculate the preferred choice given an array of interests.

Constructor

# new PreferredChoice(choices, interestIDs)

Creates a new PreferredChoice instance given the array of choices and array of interestIDs.

Parameters:
Name Type Description
choices
interestIDs

View Source api/degree-plan/PreferredChoice.ts, line 7

Methods

# getBestChoices() → {*}

Returns an array of the choices that best match the interestIDs.

View Source api/degree-plan/PreferredChoice.ts, line 32

an array of the choices that best match the interests.

*

# getOrderedChoices() → {Array}

Returns an array with the best matches first.

View Source api/degree-plan/PreferredChoice.ts, line 39

Array

# hasPreferences() → {boolean}

Returns true if there are any preferences.

View Source api/degree-plan/PreferredChoice.ts, line 53

true if max !== 0.

boolean