Client

Client

new Client()

Source:

Main class

Extends

Methods

_get(endpoint) → {Promise}

Source:
Inherited From:

Promisified request method.

Parameters:
Name Type Description
endpoint *
Returns:
Type
Promise

getEvent(eventCode, year) → {Promise}

Source:

Gets an Event.

Parameters:
Name Type Description
eventCode *
year *
Returns:
Type
Promise

getEventsForTeam(team) → {Promise}

Source:

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

Parameters:
Name Type Description
team *
Returns:
Type
Promise
Source:

Gets stream channel for the given team.

Parameters:
Name Type Description
event *
Returns:
Type
String

getMatch(event, compLevel, matchNum, semiNumopt) → {Promise}

Source:

Gets a Match object for the given match key.

Parameters:
Name Type Attributes Default Description
event *
compLevel *
matchNum *
semiNum string <optional>
''
Returns:
Type
Promise

getMatchesAtEvent(event) → {Promise}

Source:

Gets a list of matches for the given event.

Parameters:
Name Type Description
event *
Returns:
Type
Promise

getStatus() → {Promise}

Source:

Returns API status, and TBA status information.

Returns:
Type
Promise

getTeam(teamKey) → {Promise}

Source:

Gets a Team object for the team referenced by the given key.

Parameters:
Name Type Description
teamKey *
Returns:
Type
Promise

getTeamAwards(team) → {Promise}

Source:

Gets a list of awards the given team has won.

Parameters:
Name Type Description
team *
Returns:
Type
Promise

getTeamsAtEvent(event) → {Promise}

Source:

Gets a list of Team objects that competed in the given event.

Parameters:
Name Type Description
event *
Returns:
Type
Promise

getTeamsInMatch(match) → {Object}

Source:

Gets a list of team for the given match.

Parameters:
Name Type Description
match *
Returns:
Type
Object

isMatchDone(match) → {Boolean}

Source:

Determines if match is finished.

Parameters:
Name Type Description
match *
Returns:
Type
Boolean

Client

new Client(optionsopt)

Source:

Creates an instance of Client.

Parameters:
Name Type Attributes Default Description
options * <optional>
{}

Methods

_get(endpoint) → {Promise}

Source:
Inherited From:

Promisified request method.

Parameters:
Name Type Description
endpoint *
Returns:
Type
Promise

getEvent(eventCode, year) → {Promise}

Source:

Gets an Event.

Parameters:
Name Type Description
eventCode *
year *
Returns:
Type
Promise

getEventsForTeam(team) → {Promise}

Source:

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

Parameters:
Name Type Description
team *
Returns:
Type
Promise
Source:

Gets stream channel for the given team.

Parameters:
Name Type Description
event *
Returns:
Type
String

getMatch(event, compLevel, matchNum, semiNumopt) → {Promise}

Source:

Gets a Match object for the given match key.

Parameters:
Name Type Attributes Default Description
event *
compLevel *
matchNum *
semiNum string <optional>
''
Returns:
Type
Promise

getMatchesAtEvent(event) → {Promise}

Source:

Gets a list of matches for the given event.

Parameters:
Name Type Description
event *
Returns:
Type
Promise

getStatus() → {Promise}

Source:

Returns API status, and TBA status information.

Returns:
Type
Promise

getTeam(teamKey) → {Promise}

Source:

Gets a Team object for the team referenced by the given key.

Parameters:
Name Type Description
teamKey *
Returns:
Type
Promise

getTeamAwards(team) → {Promise}

Source:

Gets a list of awards the given team has won.

Parameters:
Name Type Description
team *
Returns:
Type
Promise

getTeamsAtEvent(event) → {Promise}

Source:

Gets a list of Team objects that competed in the given event.

Parameters:
Name Type Description
event *
Returns:
Type
Promise

getTeamsInMatch(match) → {Object}

Source:

Gets a list of team for the given match.

Parameters:
Name Type Description
match *
Returns:
Type
Object

isMatchDone(match) → {Boolean}

Source:

Determines if match is finished.

Parameters:
Name Type Description
match *
Returns:
Type
Boolean