Class FacultyAPI

An API to retrieve data from the Faculty store

Hierarchy

DataSource<ContextBase>
- FacultyAPI

Index

Constructors

constructor

Properties

faculties

Methods

Constructors

constructor

new FacultyAPI(): FacultyAPI

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

Returns FacultyAPI

Properties

Private faculties

faculties: Faculty[]

The Faculty store

Methods

getFaculties

getFaculties(): Faculty[]

- Defined in apollo/server/datasources/faculty.ts:37
Find all faculties

Returns Faculty[]

An array of faculties

getFaculty

getFaculty(code: string): Faculty | undefined

- Defined in apollo/server/datasources/faculty.ts:29
Find a facultiy by code

Parameters
- code: string
  
  The code of the faculty
Returns Faculty | undefined

The matched faculty or undefined if not found

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