Class MajorAPI

An API to retrieve data from the Major store

Hierarchy

DataSource<ContextBase>
- MajorAPI

Index

Constructors

constructor

Properties

majors

Methods

Constructors

constructor

new MajorAPI(): MajorAPI

- Defined in apollo/server/datasources/major.ts:14
Create the API instance.

Returns MajorAPI

Properties

Private majors

majors: Major[]

The Major store

Methods

getMajor

getMajor(code: string): Major | undefined

- Defined in apollo/server/datasources/major.ts:29
Find a major program by code

Parameters
- code: string
  
  The code of the major program
Returns Major | undefined

The matched major or undefined if not found

getMajors

getMajors(): Major[]

- Defined in apollo/server/datasources/major.ts:37
Find all major programs

Returns Major[]

An array of major programs

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