Class SmogonApiClient

API client to load data from Smogon API.

Hierarchy

SmogonApiClient

Index

Constructors

constructor

Methods

fetchFormats fetchLeads fetchMetagame fetchMovesets fetchTimeframes fetchUsages

Constructors

constructor

new SmogonApiClient(config?: Partial<SmogonApiClientConfig>): SmogonApiClient
Creates a new instance.
Parameters
- config: Partial<SmogonApiClientConfig> = {}
  
  Client config. See SmogonApiClientConfig.
Returns SmogonApiClient
- Defined in api/SmogonApiClient.ts:48

Methods

fetchFormats

fetchFormats(timeframe: Timeframe, useMonotype?: boolean): Promise<Format[]>
Loads a list of all available formats for a given timeframe.

Returns
List of formats.
Parameters
- timeframe: Timeframe
  
  Timeframe to load.
- useMonotype: boolean = false
  
  If monotype formats should be loaded instead of "normal" formats, defaults to false.
Returns Promise<Format[]>
- Defined in api/SmogonApiClient.ts:75

fetchLeads

fetchLeads(timeframe: Timeframe, format: Format): Promise<Leads>
Loads lead data for the given timeframe and format.

Returns
Leads data.
Parameters
- timeframe: Timeframe
  
  Timeframe to load.
- format: Format
  
  Format to load.
Returns Promise<Leads>
- Defined in api/SmogonApiClient.ts:116

fetchMetagame

fetchMetagame(timeframe: Timeframe, format: Format): Promise<Metagame>
Loads metagame data for the given timeframe and format.

Returns
Metagame data.
Parameters
- timeframe: Timeframe
  
  Timeframe to load.
- format: Format
  
  Format to load.
Returns Promise<Metagame>
- Defined in api/SmogonApiClient.ts:137

fetchMovesets

fetchMovesets(timeframe: Timeframe, format: Format): Promise<Movesets>
Loads moveset data for the given timeframe and format.

Note: The /chaos/ and the /moveset/ endpoints are identical in terms of data. Previously this method aliased to fetchChaos which was removed for consistency.

Returns
Moveset data.
Parameters
- timeframe: Timeframe
  
  Timeframe to load.
- format: Format
  
  Format to load.
Returns Promise<Movesets>
- Defined in api/SmogonApiClient.ts:163

fetchTimeframes

fetchTimeframes(): Promise<Timeframe[]>
Loads a list of all available timeframes.

Returns
List of timeframe names.

Returns Promise<Timeframe[]>
- Defined in api/SmogonApiClient.ts:60

fetchUsages

fetchUsages(timeframe: Timeframe, format: Format): Promise<Usages>
Loads usage data for the given timeframe and format.

Returns
Usages data.
Parameters
- timeframe: Timeframe
  
  Timeframe to load.
- format: Format
  
  Format to load.
Returns Promise<Usages>
- Defined in api/SmogonApiClient.ts:96

Class SmogonApiClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: Partial<SmogonApiClientConfig> = {}

Returns SmogonApiClient

Methods

fetchFormats

Returns

Parameters

timeframe: Timeframe

useMonotype: boolean = false

Returns Promise<Format[]>

fetchLeads

Returns

Parameters

timeframe: Timeframe

format: Format

Returns Promise<Leads>

fetchMetagame

Returns

Parameters

timeframe: Timeframe

format: Format

Returns Promise<Metagame>

fetchMovesets

Returns

Parameters

timeframe: Timeframe

format: Format

Returns Promise<Movesets>

fetchTimeframes

Returns

Returns Promise<Timeframe[]>

fetchUsages

Returns

Parameters

timeframe: Timeframe

format: Format

Returns Promise<Usages>

Settings

Member Visibility

Theme