Class College

constructor

• new College(customCollegeData?: collegeDataInterface): College

• Initiates an instance of College

  Parameters

  • customCollegeData: collegeDataInterface = collegedata

    Custom college data, defaults to the built in json.

  Returns College

  Author

  jez020

collegeData

countryCode

getCollege

• getCollege(name?: string): collegeDataInterface

• Get the colleges with the same name as the input

  Parameters

  • name: string = "University of California, San Diego"

    The name of the college, case sensitive

  Returns collegeDataInterface

  An array of objects containing the college data

  Author

  jez020

getRegion

• getRegion(regionCode?: string[]): collegeDataInterface

• Get all the colleges based on a country code

  Parameters

  • regionCode: string[] = ...

    an array of 2 letters country codes to include in the data

  Returns collegeDataInterface

  Returns an array of colleges belonging to the countries provided

  Author

  jez020