Class ExecutiveAPI

An API to retrieve data from the Executive store

Hierarchy

DataSource<ContextBase>
- ExecutiveAPI

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ExecutiveAPI(executiveStore: typeof Executive, logger: LogEntryAPI, sequelize: Sequelize): ExecutiveAPI

- Defined in apollo/server/datasources/executive.ts:26
Create the API instance.

Parameters
- executiveStore: typeof Executive
  
  A Executive store.
- logger: LogEntryAPI
- sequelize: Sequelize
Returns ExecutiveAPI

Properties

Private logger

logger: LogEntryAPI

The logger

Private sequelize

sequelize: Sequelize

The sequelize connection

Private store

store: typeof Executive

The Executive store

Methods

addNewExecutive

addNewExecutive(arg: ExecutiveCreationAttributes, who: string | undefined): Promise<ExecutiveAttributes>

- Defined in apollo/server/datasources/executive.ts:77
Add a new executive

async

Parameters
- arg: ExecutiveCreationAttributes
  
  The arg for the new executive
- who: string | undefined
  
  Who performed the action
Returns Promise<ExecutiveAttributes>

An instance of the new executive

countExecutives

countExecutives(): Promise<number>

- Defined in apollo/server/datasources/executive.ts:57
Count number of executive

async

Returns Promise<number>

Number of executives

findExecutive

findExecutive(sid: string): Promise<ExecutiveAttributes | null>

- Defined in apollo/server/datasources/executive.ts:48
Find executive by sid

async

Parameters
- sid: string
Returns Promise<ExecutiveAttributes | null>

An instance of executive or null if not found

findExecutives

findExecutives(): Promise<ExecutiveAttributes[]>

- Defined in apollo/server/datasources/executive.ts:66
Find all executives

async

Returns Promise<ExecutiveAttributes[]>

An array of executives

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>

removeExecutive

removeExecutive(sid: string, who: string | undefined): Promise<number>

- Defined in apollo/server/datasources/executive.ts:157
Remove executive

async

Parameters
- sid: string
  
  The arg for the executive
- who: string | undefined
  
  Who performed the action
Returns Promise<number>

Number of executives deleted

updateExecutive

updateExecutive(arg: ExecutiveUpdateAttributes, who: string | undefined): Promise<ExecutiveAttributes>

- Defined in apollo/server/datasources/executive.ts:114
Update an executive

async

Parameters
- arg: ExecutiveUpdateAttributes
  
  The arg for updating the executive
- who: string | undefined
  
  Who performed the action
Returns Promise<ExecutiveAttributes>

The updated executive

Generated using TypeDoc