Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Team

Represents a Team

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly address

address: null | string

The Teams address

Readonly city

city: string

The Teams city

Readonly coutry

coutry: string

The Teams country

Readonly gmapsPlaceId

gmapsPlaceId: null | string

The Teams Google Maps Place ID

Readonly gmapsUrl

gmapsUrl: null | string

The Teams Google Maps URL

Readonly homeChampionship

homeChampionship: unknown

The Teams home championship

Readonly key

key: string

The Team key

example

frc121

Readonly lat

lat: null | number

Readonly lng

lng: null | number

Readonly locationName

locationName: null | string

The Teams location name

Readonly motto

motto: null | string

The Teams motto

Readonly name

name: string

The Teams name

Readonly nickname

nickname: string

The Teams nickname

Readonly postalCode

postalCode: string

The Teams Zip Code

Readonly rookieYear

rookieYear: number

The Teams rookie year

Readonly schoolName

schoolName: string

The Teams school name

Readonly stateProv

stateProv: string

The Teams state/provence

Readonly teamNumber

teamNumber: number

The Team number

example

121

Readonly website

website: null | string

The Teams website

Methods

getDistricts

getEventKeys

  • getEventKeys(): Promise<string[]>

getEventKeysByYear

  • getEventKeysByYear(year?: string): Promise<string[]>

  • Gets a list of the event keys for all events this team has competed at.

    Parameters

    • year: string = ...

      Competition Year (or Season). Must be 4 digits. Defaults to current year

    Returns Promise<string[]>

    array of event keys

getEventStatusesByYear

  • getEventStatusesByYear(year?: string): Promise<EventStatus[]>

getEvents

  • getEvents(): Promise<Event[]>

getEventsByYear

  • getEventsByYear(year?: string): Promise<Event[]>

  • Gets a list of all events this team has competed at in the given year. Defaults to current year

    Parameters

    • year: string = ...

      Competition Year (or Season). Must be 4 digits. Defaults to current year

    Returns Promise<Event[]>

    array of Events

getEventsSimple

getEventsSimpleByYear

  • getEventsSimpleByYear(year?: string): Promise<EventSimple[]>

getRobots

  • getRobots(): Promise<Robot[]>

  • Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot.

    Returns Promise<Robot[]>

    array of Robots

getYearsParticipated

  • getYearsParticipated(): Promise<string[]>

Made by Horyus. Documentation generated by TypeDoc.