Class Teams

Hierarchy (View Summary)

default
- Teams
  - Fields

Index

Constructors

Properties

Accessors

amplify ctx errorFunction

Methods

_error _errorFunction _init avg createID createTeam deleteTeam getDB isNumeric loadTeams updateTeam validateTeam

Constructors

constructor

new Teams(): Teams
Class constructor. Calls _init() on the superclass. Add parameters as needed

Returns Teams
Overrides default.constructor
- Defined in src/ViewModel/Teams.vm.ts:49

Properties

`Protected`_ctx

_ctx: FLEXContextVariables

Member

ctx

Accessors

amplify

get amplify(): Client
Returns Client
Inherited from DGUtility.amplify
- Defined in src/Model/DGUtility.m.ts:86
set amplify(amplify: Client): void
Parameters
- amplify: Client
Returns void
Inherited from DGUtility.amplify
- Defined in src/Model/DGUtility.m.ts:74

ctx

get ctx(): FLEXContextVariables
Returns FLEXContextVariables
Inherited from DGUtility.ctx
- Defined in src/Model/DGUtility.m.ts:82
set ctx(ctx: FLEXContextVariables): void
Parameters
- ctx: FLEXContextVariables
Returns void
Inherited from DGUtility.ctx
- Defined in src/Model/DGUtility.m.ts:78

errorFunction

set errorFunction(error: (errors: string[] | number[] | object[]) => void): void
Parameters
- error: (errors: string[] | number[] | object[]) => void
Returns void
Inherited from DGUtility.errorFunction
- Defined in src/Model/DGUtility.m.ts:70

Methods

`Protected`_error

_error(errors: string[] | number[] | object[]): void
- Protected Members **
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from default._error
- Defined in src/Model/DGUtility.m.ts:22

`Protected`_errorFunction

_errorFunction(errors: string[] | number[] | object[]): void
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from default._errorFunction
- Defined in src/Model/DGUtility.m.ts:42

`Protected`_init

_init(): void
Initialize and perform setup for the class

Returns void
Overrides default._init
- Defined in src/ViewModel/Teams.vm.ts:39

avg

avg(arr: number[]): number
Averages an array of numbers
Parameters
- arr: number[]
  an array of numbers to average
Returns number
the average of the elements in the array
Inherited from default.avg
- Defined in src/Model/DGUtility.m.ts:60

createID

createID(): string | number[]
Generate a random string of characters to be used as a unique id

Returns string | number[]
the result of the call to the uuid function
Inherited from default.createID
- Defined in src/Model/DGElement.m.ts:30

createTeam

createTeam(createTeamInput: CreateTeamInput): Promise<Team>
Create a new team
Parameters
- createTeamInput: CreateTeamInput
  The team to create
Returns Promise<Team>
the created team
- Defined in src/ViewModel/Teams.vm.ts:76

deleteTeam

deleteTeam(teamID: number): Promise<Team>
Delete a team
Parameters
- teamID: number
  The ID of the team to delete
Returns Promise<Team>
the deleted team
- Defined in src/ViewModel/Teams.vm.ts:143

getDB

getDB(): Client
Returns Client
the value of the db private member

See
DGAmplifyTools
Inherited from default.getDB
- Defined in src/Model/DGUtility.m.ts:66

isNumeric

isNumeric(n: string): boolean
Parameters
- n: string
Returns boolean
Inherited from default.isNumeric
- Defined in src/Model/DGUtility.m.ts:90

loadTeams

loadTeams(): Promise<Team[]>
Load all teams

Returns Promise<Team[]>
the teams
- Defined in src/ViewModel/Teams.vm.ts:129

updateTeam

updateTeam(updateTeamInput: UpdateTeamInput): Promise<Team>
Update a team
Parameters
- updateTeamInput: UpdateTeamInput
  The team to update
Returns Promise<Team>
the updated team
- Defined in src/ViewModel/Teams.vm.ts:103

validateTeam

validateTeam(team: CreateTeamInput | UpdateTeamInput): boolean
Validate the team input
Parameters
- team: CreateTeamInput | UpdateTeamInput
  The team to validate
Returns boolean
true if the team is valid, false otherwise
- Defined in src/ViewModel/Teams.vm.ts:60