Function

if the course spans at least two departments

public buildAreaId(objectPattern: {"name": , "type": , "revision": }): source

import {buildAreaId} from 'gobbldygook/src/models/study.js'

Params:

Name	Type	Attribute	Description
objectPattern	{"name": , "type": , "revision": *}	default: {"name":null,"type":null,"revision":null}

Return:

public buildDept(course: Course): String source

import buildDept from 'gobbldygook/src/helpers/build-dept.js'

Builds a department string from a course.

AS/RE => ASIAN/REL ASIAN/REL => ASIAN/REL ASIAN/RELIGION => ASIAN/REL

Params:

Name	Type	Attribute	Description
course	Course		the course

Return:

the department string

public buildDeptNum(course: Course): String source

import buildDeptNum from 'gobbldygook/src/helpers/build-dept-num.js'

Builds a deptnum string from a course.

Params:

Name	Type	Attribute	Description
course	Course		the course

Return:

the deptnum string

public buildQueryFromString(queryString: string, opts: {}): * source

import buildQueryFromString from 'gobbldygook/src/helpers/build-query-from-string.js'

Params:

Name	Type	Attribute	Description
queryString	string	optional default:
opts	{}	optional default: {}

Return:

public calculateNextScheduleId(schedules: Array): Number source

import calculateNextScheduleId from 'gobbldygook/src/helpers/calculate-next-schedule-id.js'

Takes a list of schedules and finds the next id number.

Params:

Name	Type	Attribute	Description
schedules	Array		the list of schedules

Return:

the largest ID in the list.

public cartesianProductOf(args: ...): source

import cartesianProductOf from 'gobbldygook/src/helpers/cartesian-product.js'

Params:

Name	Type	Attribute	Description
args	...*

Return:

public checkCoursesFor(courses: Array, filter: String | Object | Function): Boolean source

import checkCoursesFor from 'gobbldygook/src/helpers/check-courses-for.js'

Checks if any courses in a list of courses pass a given lodash filter.

Params:

Name	Type	Attribute	Description
courses	Array		the list of courses
filter	String \| Object \| Function		any valid lodash filter

Return:

from _.any

public checkForInvalidSemester(course: , scheduleSemester: ): * source

import {checkForInvalidSemester} from 'gobbldygook/src/lib/find-course-warnings.js'

Params:

Name	Type	Attribute	Description
course	*
scheduleSemester	*

Return:

public checkForInvalidYear(course: , scheduleYear: ): * source

import {checkForInvalidYear} from 'gobbldygook/src/lib/find-course-warnings.js'

Params:

Name	Type	Attribute	Description
course	*
scheduleYear	*

Return:

public checkForTimeConflicts(courses: ): source

import {checkForTimeConflicts} from 'gobbldygook/src/lib/find-course-warnings.js'

Params:

Name	Type	Attribute	Description
courses	*

Return:

public checkStudentGraduatability(student: Student): Promise source

import checkStudentGraduatability from 'gobbldygook/src/lib/check-student-graduatability.js'

Checks a student objects graduation possibilities against all of its areas of study.

Params:

Name	Type	Attribute	Description
student	Student		the student object

Return:

Promise

the promise of knowledge

public checkSystemReqirements(): boolean source

import checkSystemReqirements from 'gobbldygook/src/start-things/system-requirements.js'

Return:

public checkThatCoursesSpanDepartmentsAndGeneds(courses: Array<Course>, geneds: Array<String>): Boolean source

import checkThatCoursesSpanDepartmentsAndGeneds from 'gobbldygook/src/helpers/check-that-courses-span-departments-and-geneds.js'

Checks that a list of courses spans at least two departments, but also checks to make sure that it's not one course that's spanning both.

Params:

Name	Type	Attribute	Description
courses	Array<Course>		the list of courses.
geneds	Array<String>		The list of geneds.

Return:

if the courses space both departments and geneds

public cleanUpPage(html: ): source

import cleanUpPage from 'gobbldygook/src/lib/clean-the-page.js'

Params:

Name	Type	Attribute	Description
html	*

Return:

public collectUsedCourses(expr: ): source

import collectUsedCourses from 'gobbldygook/src/lib/collect-used-courses.js'

Params:

Name	Type	Attribute	Description
expr	*

Return:

public combinations(set: Array, k: Number): Array source

import combinations from 'gobbldygook/src/helpers/base-combinations.js'

Get k-sized combinations of elements in a set.

Usage: combinations(set, k)

Examples:

combinations([1, 2, 3], 1) -> [[1], [2], [3]]

combinations([1, 2, 3], 2) -> [[1,2], [1,3], [2, 3]]

combinations([1, 2, 3], 3) -> [[1, 2, 3]]

combinations([1, 2, 3], 4) -> []

combinations([1, 2, 3], 0) -> []

combinations([1, 2, 3], -1) -> []

combinations([], 0) -> []

Params:

Name	Type	Attribute	Description
set	Array		Array of objects of any type. They are treated as unique.
k	Number		size of combinations to search for.

Return:

Array

Array of found combinations; the size of a combination is k.

public * combinations(array: *[], count: number) source

import combinations from 'gobbldygook/src/helpers/combinations.js'

Params:

Name	Type	Attribute	Description
array	*[]	optional default: []
count	number	optional default: 0

public comboHasAllCourses(courses: , combinationOfClasses: ): * source

import comboHasAllCourses from 'gobbldygook/src/lib/combo-has-courses.js'

Params:

Name	Type	Attribute	Description
courses	*
combinationOfClasses	*

Return:

public compute(requirement: , objectPattern1: {"path": , "courses": , "overrides": , "dirty": }): source

import compute from 'gobbldygook/src/lib/compute.js'

Params:

Name	Type	Attribute	Description
requirement	*
objectPattern1	{"path": , "courses": , "overrides": , "dirty": }	default: {"path":null,"courses":null,"overrides":null,"dirty":null}

Return:

public computeBoolean(expr: Object, ctx: Requirement, courses: Course[], dirty: Course[]): boolean source

import {computeBoolean} from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of a boolean expression.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to process
ctx	Requirement		the requirement context
courses	Course[]		the list of courses to search
dirty	Course[]		the list of dirty courses

Return:

the result of the modifier

public computeChunk(expr: Object, ctx: Requirement, courses: Course[], dirty: Course[]): boolean source

import computeChunk from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of an expression.

It operates by calling a more specific function based on the type of the expression.

There are three types of compute functions: those that need the surrounding context, those that don't, and the supervisor function.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to process
ctx	Requirement		the entire requirement context
courses	Course[]		the list of courses to search
dirty	Course[]		the list of dirty courses

Return:

the result of the expression

public computeCountWithOperator(objectPattern: {"comparator": , "has": , "needs": }): source

import computeCountWithOperator from 'gobbldygook/src/lib/compute-count-with-operator.js'

Params:

Name	Type	Attribute	Description
objectPattern	{"comparator": , "has": , "needs": *}	default: {"comparator":null,"has":null,"needs":null}

Return:

public computeCourse(expr: Object, courses: Course[], dirty: Course[]): boolean source

import {computeCourse} from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of a course expression.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to build a query from
courses	Course[]		the list of courses to search
dirty	Course[]		the list of dirty courses

Return:

if the course was found or not

public computeModifier(expr: Object, ctx: Requirement, courses: Course[]): boolean source

import {computeModifier} from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of a modifier expression.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to process
ctx	Requirement		the requirement context
courses	Course[]		the list of courses to search

Return:

the result of the modifier

public computeOccurrence(expr: Object, courses: Course[]): boolean source

import {computeOccurrence} from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of an occurrence expression.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to process
courses	Course[]		the list of courses to search

Return:

the result of the occurrence

public computeOf(expr: Object, ctx: Requirement, courses: Course[], dirty: Course[]): boolean source

import {computeOf} from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of an of-expression.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to process
ctx	Requirement		the requirement context
courses	Course[]		the list of courses to search
dirty	Course[]		the list of dirty courses

Return:

the result of the of-expression

public computeReference(expr: Object, ctx: Requirement): boolean source

import {computeReference} from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of a reference expression.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to process
ctx	Requirement		the requirement context

Return:

the result of the reference expression

public computeWhere(expr: Object, courses: Course[]): boolean source

import {computeWhere} from 'gobbldygook/src/lib/compute-chunk.js'

Computes the result of a where-expression.

Params:

Name	Type	Attribute	Description
expr	Object		the expression to process
courses	Course[]		the list of courses to search

Return:

the result of the where-expression

public concatAndMerge(a: , b: ): * source

import concatAndMerge from 'gobbldygook/src/helpers/concat-and-merge.js'

Params:

Name	Type	Attribute	Description
a	*
b	*

Return:

public countGeneds(courses: Array, gened: Array): Number source

import countGeneds from 'gobbldygook/src/helpers/count-geneds.js'

Counts the number of occurrences of a gened in a list of courses.

Params:

Name	Type	Attribute	Description
courses	Array		the list of courses.
gened	Array		the gened to look for.

Return:

the number of occurrences.

public createSchedules(courses: ): source

import createSchedules from 'gobbldygook/src/lib/create-schedules.js'

Params:

Name	Type	Attribute	Description
courses	*

Return:

public enhanceHanson(data: , objectPattern1: {"topLevel": }): * source

import enhanceHanson from 'gobbldygook/src/lib/enhance-hanson.js'

Params:

Name	Type	Attribute	Description
data	*
objectPattern1	{"topLevel": *}	optional default: {}

Return:

public evaluate(objectPattern: {"courses": , "overrides": }, area: ): source

import evaluate from 'gobbldygook/src/lib/evaluate.js'

Params:

Name	Type	Attribute	Description
objectPattern	{"courses": , "overrides": }	default: {"courses":null,"overrides":null}
area	*

Return:

public expandDepartment(dept: ): source

import expandDepartment from 'gobbldygook/src/lib/expand-department.js'

Params:

Name	Type	Attribute	Description
dept	*

Return:

public expandOldName(name: *): string source

import {expandOldName} from 'gobbldygook/src/models/study.js'

Params:

Name	Type	Attribute	Description
name	*

Return:

public expandOldRevisionYear(revisionYear: *): string source

import {expandOldRevisionYear} from 'gobbldygook/src/models/study.js'

Params:

Name	Type	Attribute	Description
revisionYear	*

Return:

public expandOldType(type: *): string source

import {expandOldType} from 'gobbldygook/src/models/study.js'

Params:

Name	Type	Attribute	Description
type	*

Return:

public expandYear(year: Number): String source

import expandYear from 'gobbldygook/src/helpers/expand-year.js'

Takes a year and expands it. eg. {in: 2012, out: 2012-13}

Params:

Name	Type	Attribute	Description
year	Number		the year to expand

Return:

the expanded year

public filterByQualification(list: , qualification: , fullList: ): source

import {filterByQualification} from 'gobbldygook/src/lib/filter-by-where-clause.js'

Params:

Name	Type	Attribute	Description
list	*
qualification	*
fullList	*

Return:

public filterByWhereClause(baseList: , clause: , fullList: ): source

import filterByWhereClause from 'gobbldygook/src/lib/filter-by-where-clause.js'

Params:

Name	Type	Attribute	Description
baseList	*
clause	*
fullList	*

Return:

public findAreaPath(objectPattern: {"name": , "type": , "revision": *}): string source

import findAreaPath from 'gobbldygook/src/lib/find-area-path.js'

Params:

Name	Type	Attribute	Description
objectPattern	{"name": , "type": , "revision": *}	default: {"name":null,"type":null,"revision":null}

Return:

public findAreasOfStudy(areas: , degreeType: ): * source

import findAreasOfStudy from 'gobbldygook/src/lib/find-areas-of-study.js'

Params:

Name	Type	Attribute	Description
areas	*
degreeType	*

Return:

public findFirstAvailableSemester(schedules: Array | Immutable.List, forYear: Number): Number source

import findFirstAvailableSemester from 'gobbldygook/src/helpers/find-first-available-semester.js'

Takes a list of schedules and finds the first open semester. If they go [1, 2, 4] findFirstAvailableSemester will return 3. If it goes [1, 2, 3] findFirstAvailableSemester will return 4. Etc.

Params:

Name	Type	Attribute	Description
schedules	Array \| Immutable.List		the list of schedules
forYear	Number		the year to look within

Return:

the first available semester slot

public findFirstAvailableYear(schedules: Array | Immutable.List, matriculation: Number): Number source

import findFirstAvailableYear from 'gobbldygook/src/helpers/find-first-available-year.js'

Takes a list of schedules and finds the first open year. If they go [2012, 2013, 2015] findFirstAvailableYear will return 2014. If it goes [2013, 2014, 2015] findFirstAvailableYear will return 2016. If schedules is empty, it will return the current year.

Params:

Name	Type	Attribute	Description
schedules	Array \| Immutable.List		the list of schedules
matriculation	Number		the year of matriculated

Return:

the first available semester slot

public findLeafRequirements(requirement: Requirement): Course[] source

import findLeafRequirements from 'gobbldygook/src/lib/find-leaf-requirements.js'

Searches recursively through a requirement tree to find all of the leaf requirements – all of the requirements with no children.

Params:

Name	Type	Attribute	Description
requirement	Requirement		the root requirement

Return:

Course[]

the leaf children

public findMissingNumberBinarySearch(arr: ): source

import findMissingNumberBinarySearch from 'gobbldygook/src/helpers/find-missing-number-binary-search.js'

Params:

Name	Type	Attribute	Description
arr	*

Return:

public findResults(obj: ): source

import findResults from 'gobbldygook/src/helpers/find-results.js'

Params:

Name	Type	Attribute	Description
obj	*

Return:

public findWarnings(courses: , schedule: ): * source

import {findWarnings} from 'gobbldygook/src/lib/find-course-warnings.js'

Params:

Name	Type	Attribute	Description
courses	*
schedule	*

Return:

public getCourse(clbid: Number): Promise source

import getCourse from 'gobbldygook/src/lib/get-course.js'

Gets a course from the database.

Params:

Name	Type	Attribute	Description
clbid	Number		a class/lab ID

Return:

Promise

TreoDatabasePromise

public getCourses(clbids: Array | Immutable.List): Promise[] source

import getCourses from 'gobbldygook/src/lib/get-courses.js'

Gets a list of course ids from the database.

Params:

Name	Type	Attribute	Description
clbids	Array \| Immutable.List		a list of class/lab IDs

Return:

Promise[]

an array of course promises

public getDepartments(courses: Course[]): String[] source

import getDepartments from 'gobbldygook/src/helpers/get-departments.js'

It plucks the departments from a list of courses, and returns the uniq'd list.

Params:

Name	Type	Attribute	Description
courses	Course[]		the list of courses

Return:

String[]

just the departments

public hasFOL(course: Course): Boolean source

import hasFOL from 'gobbldygook/src/helpers/has-fol.js'

Checks if a course has an FOL gened.

Params:

Name	Type	Attribute	Description
course	Course		the course to check

Return:

if any gereqs are FOL requirements

public humanizeOperator(operator: *): string source

import humanizeOperator from 'gobbldygook/src/lib/humanize-operator.js'

Params:

Name	Type	Attribute	Description
operator	*

Return:

public incrementProgress(id: , by: number): source

import {incrementProgress} from 'gobbldygook/src/ducks/notifications.js'

Params:

Name	Type	Attribute	Description
id	*
by	number	optional default: 1

Return:

public isIntercollegiateSport(course: Course): Boolean source

import isIntercollegiateSport from 'gobbldygook/src/helpers/is-intercollegiate-sport.js'

Only one SPM course credit may be earned by students as a result of participation in an approved intercollegiate sport. This credit must be entered as Exercise Science 171-194 at the registration preceding the sport/participation term.

Params:

Name	Type	Attribute	Description
course	Course		the course to check

Return:

if the course is an intercollegiate sport

public isogram() source

import {isogram} from 'gobbldygook/src/start-things/analytics.js'

public json(response: ): source

import {json} from 'gobbldygook/src/lib/fetch-helpers.js'

Params:

Name	Type	Attribute	Description
response	*

Return:

public loadArea(objectPattern: {"name": , "type": , "revision": , "source": , "isCustom": }): source

import {loadArea} from 'gobbldygook/src/models/study.js'

Params:

Name	Type	Attribute	Description
objectPattern	{"name": , "type": , "revision": , "source": , "isCustom": *}	default: {"name":null,"type":null,"revision":null,"source":null,"isCustom":null}

Return:

public loadData(): * source

import loadData from 'gobbldygook/src/lib/load-data.js'

Return:

public logError(objectPattern: {"error": , "quiet": , "id": }, args: ...): * source

import {logError} from 'gobbldygook/src/ducks/notifications.js'

Params:

Name	Type	Attribute	Description
objectPattern	{"error": , "quiet": , "id": *}	default: {"error":null,"quiet":null,"id":null}
args	...*

Return:

public logMessage(id: , message: ): * source

import {logMessage} from 'gobbldygook/src/ducks/notifications.js'

Params:

Name	Type	Attribute	Description
id	*
message	*

Return:

public makeStudent(tables: , degreeType: ): * source

import makeStudent from 'gobbldygook/src/lib/make-student.js'

Params:

Name	Type	Attribute	Description
tables	*
degreeType	*

Return:

public migrateFromOldSave(objectPattern: {"id": , "revisionYear": }): * source

import {migrateFromOldSave} from 'gobbldygook/src/models/study.js'

Params:

Name	Type	Attribute	Description
objectPattern	{"id": , "revisionYear": }	default: {"id":null,"revisionYear":null}

Return:

public nameTheTables(tables: ): source

import nameTheTables from 'gobbldygook/src/lib/name-the-tables.js'

Params:

Name	Type	Attribute	Description
tables	*

Return:

public onlyQuarterCreditCoursesCanBePassFail(course: Course): boolean source

import onlyQuarterCreditCoursesCanBePassFail from 'gobbldygook/src/helpers/only-quarter-credit-courses-can-be-pass-fail.js'

Params:

Name	Type	Attribute	Description
course	Course

Return:

public parseDataFromHTML(): * source

import parseDataFromHTML from 'gobbldygook/src/lib/parse-data-from-html.js'

Return:

public parseDataFromJSON(jsonData: ): source

import parseDataFromJSON from 'gobbldygook/src/lib/parse-data-from-json.js'

Params:

Name	Type	Attribute	Description
jsonData	*

Return:

public parseSIS(html: ): source

import parseSIS from 'gobbldygook/src/lib/parse-sis.js'

Params:

Name	Type	Attribute	Description
html	*

Return:

public plugin(db: , treo: ) source

import plugin from 'gobbldygook/src/lib/query-treo-database.js'

Params:

Name	Type	Attribute	Description
db	*
treo	*

public plugin(db: , treo: ) source

import plugin from 'gobbldygook/src/lib/treo-batch-get.js'

Params:

Name	Type	Attribute	Description
db	*
treo	*

public prepareCourseForQuery(course: ): source

import prepareCourseForQuery from 'gobbldygook/src/lib/prepare-course-for-query.js'

Params:

Name	Type	Attribute	Description
course	*

Return:

public prettifyCourses(jsonCourses: ): source

import prettifyCourses from 'gobbldygook/src/lib/prettify-courses.js'

Params:

Name	Type	Attribute	Description
jsonCourses	*

Return:

public processAreaTable(areaTable: ): source

import processAreaTable from 'gobbldygook/src/lib/process-area-table.js'

Params:

Name	Type	Attribute	Description
areaTable	*

Return:

public processCoursesTable(coursesTable: ): source

import processCoursesTable from 'gobbldygook/src/lib/process-courses-table.js'

Params:

Name	Type	Attribute	Description
coursesTable	*

Return:

public processGradTable(gradTable: ): source

import processGradTable from 'gobbldygook/src/lib/process-grad-table.js'

Params:

Name	Type	Attribute	Description
gradTable	*

Return:

public processInfoTable(infoTable: ): source

import processInfoTable from 'gobbldygook/src/lib/process-info-table.js'

Params:

Name	Type	Attribute	Description
infoTable	*

Return:

public quacksLikeDeptNum(deptNumString: String): Boolean source

import quacksLikeDeptNum from 'gobbldygook/src/helpers/quacks-like-dept-num.js'

Checks if a string looks like a deptnum.

Params:

Name	Type	Attribute	Description
deptNumString	String		the deptnum

Return:

does it quack like a deptnum?

public queryCourseDatabase(queryString: , baseQuery: {}): source

import queryCourseDatabase from 'gobbldygook/src/lib/query-course-database.js'

Params:

Name	Type	Attribute	Description
queryString	*
baseQuery	{}	optional default: {}

Return:

public queryCourses(queryObj: Object, courses: Array<Course>): Array<Course> source

import queryCourses from 'gobbldygook/src/helpers/query-courses.js'

Queries the database for courses.

Params:

Name	Type	Attribute	Description
queryObj	Object		the query
courses	Array<Course>		the courses to query

Return:

Array<Course>

the courses that matched the query

public reducer(state: , action: ): * source

import reducer from 'gobbldygook/src/ducks/notifications.js'

Params:

Name	Type	Attribute	Description
state	*	optional default: initialState
action	*

Return:

public removeNotification(id: ): source

import {removeNotification} from 'gobbldygook/src/ducks/notifications.js'

Params:

Name	Type	Attribute	Description
id	*

Return:

public searchForCourseMatches(queryObject: ): source

import searchForCourseMatches from 'gobbldygook/src/lib/search-for-course-matches.js'

Params:

Name	Type	Attribute	Description
queryObject	*

Return:

public semesterName(semester: Number): String source

import semesterName from 'gobbldygook/src/helpers/semester-name.js'

Takes a semester number and returns the associated semester string.

Params:

Name	Type	Attribute	Description
semester	Number		the semester (number)

Return:

the nice semester name

public slugifyAreaName(name: ): source

import {slugifyAreaName} from 'gobbldygook/src/lib/find-area-path.js'

Params:

Name	Type	Attribute	Description
name	*

Return:

public splitDeptNum(deptNumString: String, includeSection: Boolean): Object source

import splitDeptNum from 'gobbldygook/src/helpers/split-dept-num.js'

Splits a deptnum string (like "AS/RE 230A") into its components, like {depts: ['AS', 'RE'], num: 230, sect: 'A'}.

Params:

Name	Type	Attribute	Description
deptNumString	String		the deptnum to split
includeSection	Boolean		include the section in the result?

Return:

Object

the result

public splitParagraph(string: string): * source

import splitParagraph from 'gobbldygook/src/helpers/split-paragraph.js'

Params:

Name	Type	Attribute	Description
string	string	optional default:

Return:

public start() source

import start from 'gobbldygook/src/polyfills/details/Element.details.js'

public startProgress(id: , message: string, objectPattern2: {"value": , "max": , "showButton": }): * source

import {startProgress} from 'gobbldygook/src/ducks/notifications.js'

Params:

Name	Type	Attribute	Description
id	*
message	string	optional default:
objectPattern2	{"value": , "max": , "showButton": *}	optional default: {}

Return:

public status(response: ): source

import {status} from 'gobbldygook/src/lib/fetch-helpers.js'

Params:

Name	Type	Attribute	Description
response	*

Return:

public tableToJson(table: ): source

import tableToJson from 'gobbldygook/src/lib/table-to-json.js'

Params:

Name	Type	Attribute	Description
table	*

Return:

public text(response: ): source

import {text} from 'gobbldygook/src/lib/fetch-helpers.js'

Params:

Name	Type	Attribute	Description
response	*

Return:

public toPrettyTerm(term: Number): String source

import toPrettyTerm from 'gobbldygook/src/helpers/to-pretty-term.js'

Takes a term and makes it pretty. eg. {in: 20121, out: Fall 2012-13}

Params:

Name	Type	Attribute	Description
term	Number		a term identifier.

Return: