Class Challonge

Wrapper class for the account based Challonge actions, such as list all tournaments and create a new tournament

Hierarchy

ChallongeBase
- Challonge

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Challonge(api_key: string): Challonge

Inherited from ChallongeBase.constructor
- Defined in challonge.ts:6
Parameters
- api_key: string
Returns Challonge

Properties

api_key

api_key: string

API key used to access challonge

tournaments

tournaments: Tournament[]

Methods

createTournament

createTournament(params: strictTournamentParameters): Promise<Tournament>

- Defined in challonge.ts:29
Create a new tournament.

Parameters
- params: strictTournamentParameters
Returns Promise<Tournament>

getTournaments

getTournaments(params?: indexTournamentsRequest): Promise<Tournament[]>

- Defined in challonge.ts:13
Retrieve a set of tournaments created with your account.

Parameters
- Optional params: indexTournamentsRequest
Returns Promise<Tournament[]>

Generated using TypeDoc