Class PokerogueApi

A wrapper for PokéRogue API requests.

Hierarchy (View Summary)

ApiBase
- PokerogueApi

Index

Constructors

Properties

account admin base daily ERR_GENERIC savedata

Methods

doFetch doGet doPost getGameTitleStats toUrlSearchParams unlinkDiscord unlinkGoogle

Constructors

constructor

new PokerogueApi(base: string): PokerogueApi
Parameters
- base: string
Returns PokerogueApi
Overrides ApiBase.constructor
- Defined in src/plugins/api/pokerogue-api.ts:21

Properties

`Readonly`account

account: PokerogueAccountApi

`Readonly`admin

admin: PokerogueAdminApi

`Protected` `Readonly`base

base: string

`Readonly`daily

daily: PokerogueDailyApi

`Readonly`ERR_GENERIC

ERR_GENERIC: string = "There was an error"

`Readonly`savedata

savedata: PokerogueSavedataApi

Methods

`Protected`doFetch

doFetch(path: string, config: RequestInit): Promise<Response>
A generic request helper.
Parameters
- path: string
  The path to send the request to.
- config: RequestInit
  The request RequestInit | Configuration.
Returns Promise<Response>
Inherited from ApiBase.doFetch
- Defined in src/plugins/api/api-base.ts:65

`Protected`doGet

doGet(path: string): Promise<Response>
Send a GET request.
Parameters
- path: string
  The path to send the request to.
Returns Promise<Response>
Inherited from ApiBase.doGet
- Defined in src/plugins/api/api-base.ts:25

`Protected`doPost

doPost<D = undefined>(
    path: string,
    bodyData?: D,
    dataType?: DataType,
): Promise<Response>
Send a POST request.
Type Parameters
- D = undefined
Parameters
- path: string
  THe path to send the request to.
- OptionalbodyData: D
  The body-data to send.
- dataType: DataType = "json"
  The data-type of the bodyData.
Returns Promise<Response>
Inherited from ApiBase.doPost
- Defined in src/plugins/api/api-base.ts:35

getGameTitleStats

getGameTitleStats(): Promise<null | TitleStatsResponse>
Request game title-stats.

Returns Promise<null | TitleStatsResponse>
- Defined in src/plugins/api/pokerogue-api.ts:32

`Protected`toUrlSearchParams

toUrlSearchParams<D extends Record<string, any>>(data: D): URLSearchParams
Helper to transform data to URLSearchParams Any key with a value of undefined will be ignored. Any key with a value of null will be included.
Type Parameters
- D extends Record<string, any>
Parameters
- data: D
  the data to transform to URLSearchParams
Returns URLSearchParams
a URLSearchParams representaton of data
Inherited from ApiBase.toUrlSearchParams
- Defined in src/plugins/api/api-base.ts:87

unlinkDiscord

unlinkDiscord(): Promise<boolean>
Unlink the currently logged in user from Discord.

Returns Promise<boolean>
true if unlinking was successful, false if not
- Defined in src/plugins/api/pokerogue-api.ts:46

unlinkGoogle

unlinkGoogle(): Promise<boolean>
Unlink the currently logged in user from Google.

Returns Promise<boolean>
true if unlinking was successful, false if not
- Defined in src/plugins/api/pokerogue-api.ts:64