Class: Event
Represents an event that belongs to a schedule.
Hierarchy
-
↳
Event
Constructors
constructor
• new Event(data, parent): Event
Parameters
| Name | Type | Description |
|---|---|---|
data | RawScheduleItem | Data to process. |
parent | Schedule | Parent schedule to set. |
Returns
Overrides
Defined in
Properties
country
• country: string
The country the event takes place in.
Defined in
eventDate
• eventDate: Date
The date of the event, which is always at midnight of the same day, in UTC.
Defined in
eventFormat
• eventFormat: EventFormat
The format of the event.
Defined in
eventName
• eventName: string
The name of the event, without sponsors. This is shorter than the official event name.
Defined in
location
• location: string
The location the event takes place in. This is usually a city or an area.
Defined in
officialEventName
• officialEventName: string
The official event name, with sponsors, etc.
Defined in
roundNumber
• roundNumber: number
The round number of the event.
Defined in
schedule
• schedule: Schedule
The schedule this event belongs to.
Defined in
sessions
• sessions: Session[]
An array of sessions that take place throughout the event.
Defined in
Accessors
isSprint
• get isSprint(): boolean
Whether the event is a sprint weekend.
Returns
boolean
Defined in
isTesting
• get isTesting(): boolean
Whether the event is pre-season testing.
Returns
boolean
Defined in
Methods
practice
▸ practice(practiceNumber): null | Session
Get a practice session by its number.
Parameters
| Name | Type | Description |
|---|---|---|
practiceNumber | number | The number of the practice session. (e.g. 1 for "Practice 1") |
Returns
null | Session
Defined in
session
▸ session(sessionNumber): null | Session
Get a session by its number,
Parameters
| Name | Type | Description |
|---|---|---|
sessionNumber | number | The number of the session. |
Returns
null | Session