Class FreedomRunResult

A class representing the Results of a Freedom Run.

Hierarchy

FreedomRunResult

Index

Constructors

Methods

getID getEvent getEventName getFinishTime getRunDate getAthleteID getEventID

Constructors

constructor

new FreedomRunResult(res: any, _core: any): FreedomRunResult
Parameters
- res: any
- _core: any
Returns FreedomRunResult
- Defined in src/classes/FreedomRunResult.ts:12

Methods

getID

getID(): number
Get the ID of this Freedom Run.

Returns
Freedom Run ID

Returns number
- Defined in src/classes/FreedomRunResult.ts:30

getEvent

getEvent(): Promise<any>
Get the event object for the event this took place at.

See
(Borrows from getEvent)

Returns
Array of news posts.

Throws
ParkrunNetError ParkrunJS Networking Error.

Returns Promise<any>
- Defined in src/classes/FreedomRunResult.ts:42

getEventName

getEventName(): string
Get the name of the event that this run took place at.

Returns
Event name.

Throws
ParkrunNetError ParkrunJS Networking Error.

Returns string
- Defined in src/classes/FreedomRunResult.ts:52

getFinishTime

getFinishTime(): string
Get the finish time for this run.

Returns
Finish time.

Returns string
- Defined in src/classes/FreedomRunResult.ts:61

getRunDate

getRunDate(): Date
Get the date of this run as a native Date object.

Returns
Date object.

Returns Date
- Defined in src/classes/FreedomRunResult.ts:70

getAthleteID

getAthleteID(): number
Get the Athlete ID of the runner.

Returns
Athlete ID.

Returns number
- Defined in src/classes/FreedomRunResult.ts:79

getEventID

getEventID(): number
Get the Event ID for this run's location.

Returns
Event ID.

Returns number
- Defined in src/classes/FreedomRunResult.ts:88

Generated using TypeDoc