Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamSimple

Represents a Simple Team

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly city

city: string

The Teams city

Private Readonly client

client: TBAClient

Readonly coutry

coutry: string

The Teams country

Readonly key

key: string

The Team key

example

frc121

Readonly name

name: string

The Teams name

Readonly nickname

nickname: string

The Teams nickname

Readonly stateProv

stateProv: string

The Teams state/provence

Readonly teamNumber

teamNumber: number

The Team number

example

121

Methods

getDistricts

  • Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district.

    Returns Promise<District[]>

    array of Districts

getEventKeys

  • getEventKeys(): Promise<string[]>

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

    Returns Promise<string[]>

    array of event keys

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[]>

  • Gets a key-value list of the event statuses for events this team has competed at in the given year.

    Parameters

    • year: string = ...

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

    Returns Promise<EventStatus[]>

    array of event keys

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[]>

  • Gets a list of all short form events this team has competed at.

    Parameters

    • year: string = ...

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

    Returns Promise<EventSimple[]>

    array of Simple Events

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[]>

  • Gets a list of years in which the team participated in at least one competition.

    Returns Promise<string[]>

    array of years participated

Made by Horyus. Documentation generated by TypeDoc.