Added some comments
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/pr Build is passing
Details
ref #56
This commit is contained in:
parent
5d31d8d1a2
commit
e0fa58da57
|
@ -44,7 +44,7 @@ export class ResponseStats {
|
|||
total_scans: number;
|
||||
|
||||
/**
|
||||
* The total distance that all runners ran.
|
||||
* The total distance that all runners ran combined.
|
||||
*/
|
||||
@IsInt()
|
||||
total_distance: number;
|
||||
|
@ -56,11 +56,20 @@ export class ResponseStats {
|
|||
total_donation: number;
|
||||
|
||||
/**
|
||||
* The average distance per runner.
|
||||
* The average distance ran per runner.
|
||||
*/
|
||||
@IsInt()
|
||||
average_distance: number;
|
||||
|
||||
/**
|
||||
* Creates a new stats response containing some basic statistics for a dashboard or public display.
|
||||
* @param runners Array containing all runners - the following relations have to be resolved: scans, scans.track
|
||||
* @param teams Array containing all teams - no relations have to be resolved.
|
||||
* @param orgs Array containing all orgs - no relations have to be resolved.
|
||||
* @param users Array containing all users - no relations have to be resolved.
|
||||
* @param scans Array containing all scans - no relations have to be resolved.
|
||||
* @param donations Array containing all donations - the following relations have to be resolved: runner, runner.scans, runner.scans.track
|
||||
*/
|
||||
public constructor(runners: Runner[], teams: RunnerTeam[], orgs: RunnerOrganisation[], users: User[], scans: Scan[], donations: Donation[]) {
|
||||
this.total_runners = runners.length;
|
||||
this.total_teams = teams.length;
|
||||
|
|
|
@ -35,8 +35,8 @@ export class ResponseStatsOrgnisation {
|
|||
donationAmount: number;
|
||||
|
||||
/**
|
||||
* Creates a ResponseRunner object from a runner.
|
||||
* @param runner The user the response shall be build for.
|
||||
* Creates a new organisation stats response from a organisation
|
||||
* @param org The organisation whoes response shall be generated - the following relations have to be resolved: runners, runners.scans, runners.distanceDonations, runners.scans.track, teams, teams.runners, teams.runners.scans, teams.runners.distanceDonations, teams.runners.scans.track
|
||||
*/
|
||||
public constructor(org: RunnerOrganisation) {
|
||||
this.name = org.name;
|
||||
|
|
|
@ -54,8 +54,8 @@ export class ResponseStatsRunner {
|
|||
group: RunnerGroup;
|
||||
|
||||
/**
|
||||
* Creates a ResponseRunner object from a runner.
|
||||
* @param runner The user the response shall be build for.
|
||||
* Creates a new runner stats response from a runner
|
||||
* @param runner The runner whoes response shall be generated - the following relations have to be resolved: scans, group, distanceDonations, scans.track
|
||||
*/
|
||||
public constructor(runner: Runner) {
|
||||
this.id = runner.id;
|
||||
|
|
|
@ -42,8 +42,8 @@ export class ResponseStatsTeam {
|
|||
parent: RunnerGroup;
|
||||
|
||||
/**
|
||||
* Creates a ResponseRunner object from a runner.
|
||||
* @param runner The user the response shall be build for.
|
||||
* Creates a new team stats response from a team
|
||||
* @param team The team whoes response shall be generated - the following relations have to be resolved: runners, runners.scans, runners.distanceDonations, runners.scans.track
|
||||
*/
|
||||
public constructor(team: RunnerTeam) {
|
||||
this.name = team.name;
|
||||
|
|
Loading…
Reference in New Issue