Class CollegeAPI

An API to retrieve data from the College store

Hierarchy

DataSource<ContextBase>
- CollegeAPI

Index

Constructors

constructor

Properties

colleges

Methods

Constructors

constructor

new CollegeAPI(): CollegeAPI

- Defined in apollo/server/datasources/college.ts:15
Create the API instance.

Returns CollegeAPI

Properties

Private colleges

colleges: College[]

The College store

Methods

getCollege

getCollege(code: CollegeEnum): College

- Defined in apollo/server/datasources/college.ts:30
Find a college by code

Parameters
- code: CollegeEnum
  
  The code of the college
Returns College

The matched college or undefined if not found

getColleges

getColleges(): College[]

- Defined in apollo/server/datasources/college.ts:42
Find all colleges

Returns College[]

An array of colleges

Optional initialize

initialize(config: DataSourceConfig<ContextBase>): void | Promise<void>

Inherited from CollegeAPI.initialize
- Defined in node_modules/apollo-datasource/dist/index.d.ts:7
Parameters
- config: DataSourceConfig<ContextBase>
Returns void | Promise<void>

Generated using TypeDoc