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/api/api.ts:15

Properties

`Readonly`account

account: PokerogueAccountApi

`Readonly`admin

admin: PokerogueAdminApi

`Protected` `Readonly`base

base: string

The base URL for HTTP requests.

`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: DoFetchConfig): Promise<Response>
A generic request helper.
Parameters
- path: string
  The path to send the request to
- config: DoFetchConfig
  The request configuration
Returns Promise<Response>
Inherited from ApiBase.doFetch
- Defined in src/api/api-base.ts:82

`Protected`doGet

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

`Protected`doPost

doPost(
    path: string,
    bodyData?: string | Record<string, any>,
    dataType?: "json",
): Promise<Response>
Send an HTTP POST request.
Parameters
- path: string
  The path to send the request to
- OptionalbodyData: string | Record<string, any>
  The body-data to send; will be stringified if needed
- OptionaldataType: "json"
  (Default "json") The type of data to send
Returns Promise<Response>
Inherited from ApiBase.doPost
- Defined in src/api/api-base.ts:38
doPost(
    path: string,
    bodyData: Record<string, any>,
    dataType: "form-urlencoded",
): Promise<Response>
Send an HTTP POST request.
Parameters
- path: string
  The path to send the request to
- bodyData: Record<string, any>
  The body-data to send; will be stringified if needed
- dataType: "form-urlencoded"
  (Default "json") The type of data to send
Returns Promise<Response>
Inherited from ApiBase.doPost
- Defined in src/api/api-base.ts:45

getGameTitleStats

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

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

`Protected`toUrlSearchParams

toUrlSearchParams(data: Record<string, any>): 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.
Parameters
- data: Record<string, any>
  the data to transform to URLSearchParams
Returns URLSearchParams
a URLSearchParams representaton of data
Inherited from ApiBase.toUrlSearchParams
- Defined in src/api/api-base.ts:105

unlinkDiscord

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

Returns Promise<boolean>
Whether unlinking was successful
- Defined in src/api/api.ts:39

unlinkGoogle

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

Returns Promise<boolean>
Whether unlinking was successful
- Defined in src/api/api.ts:57