Class: PikaNetworkClient

typed, runtime-validated client

Extends

• PikaNetworkFeatureSet

Constructors

Constructor

new PikaNetworkClient(options?: PikaNetworkClientOptions): PikaNetworkClient;

Parameters

Parameter	Type
options	PikaNetworkClientOptions

Returns

PikaNetworkClient

Overrides

PikaNetworkFeatureSet.constructor

Methods

batch()

batch<T>(operations: T, options?: BatchOptions): Promise<{ [K in string | number | symbol]: BatchResult<Awaited<ReturnType<T[K]>>> }>;

executes operations with bounded concurrency

default: 10; override via batchConcurrency or per-call concurrency.

every operation still goes through the same rate limiter as a single call. refer to the batch requests guide for the full contract.

Type Parameters

Type Parameter
T extends readonly () => Promise<unknown>[]

Parameters

Parameter	Type
operations	T
options?	BatchOptions

Returns

Promise<{ [K in string | number | symbol]: BatchResult<Awaited<ReturnType<T[K]>>> }>

Inherited from

PikaNetworkFeatureSet.batch

---

clearCache()

clearCache(): Promise<void>;

Clears the entire client cache.

Returns

Promise<void>

Inherited from

PikaNetworkFeatureSet.clearCache

---

getClan()

getClan(clanName: string, config?: RequestConfig): Promise<
  | objectOutputType<{
  createdAt: ZodOptional<ZodUnion<[ZodNumber, ZodString]>>;
  creationTime: ZodOptional<ZodString>;
  currentTrophies: ZodOptional<ZodNumber>;
  leveling: ZodOptional<ZodObject<{
     exp: ZodOptional<ZodNumber>;
     level: ZodOptional<ZodNumber>;
     totalExp: ZodOptional<ZodNumber>;
   }, "strip", ZodTypeAny, {
     exp?: number;
     level?: number;
     totalExp?: number;
   }, {
     exp?: number;
     level?: number;
     totalExp?: number;
  }>>;
  members: ZodOptional<ZodArray<ZodObject<{
     joinDate: ZodOptional<ZodString>;
     rank: ZodOptional<ZodString>;
     user: ZodObject<{
        username: ZodString;
      }, "strip", ZodTypeAny, {
        username: string;
      }, {
        username: string;
     }>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     joinDate: ZodOptional<ZodString>;
     rank: ZodOptional<ZodString>;
     user: ZodObject<{
        username: ...;
      }, "strip", ZodTypeAny, {
        username: ...;
      }, {
        username: ...;
     }>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     joinDate: ZodOptional<ZodString>;
     rank: ZodOptional<ZodString>;
     user: ZodObject<{
        username: ...;
      }, "strip", ZodTypeAny, {
        username: ...;
      }, {
        username: ...;
     }>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  name: ZodOptional<ZodString>;
  owner: ZodOptional<ZodObject<{
     username: ZodString;
   }, "strip", ZodTypeAny, {
     username: string;
   }, {
     username: string;
  }>>;
  tag: ZodOptional<ZodString>;
  trophies: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">
| null>;

Parameters

Parameter	Type
clanName	string
config?	RequestConfig

Returns

Promise< | objectOutputType<{ createdAt: ZodOptional<ZodUnion<[ZodNumber, ZodString]>>; creationTime: ZodOptional<ZodString>; currentTrophies: ZodOptional<ZodNumber>; leveling: ZodOptional<ZodObject<{ exp: ZodOptional<ZodNumber>; level: ZodOptional<ZodNumber>; totalExp: ZodOptional<ZodNumber>; }, "strip", ZodTypeAny, { exp?: number; level?: number; totalExp?: number; }, { exp?: number; level?: number; totalExp?: number; }>>; members: ZodOptional<ZodArray<ZodObject<{ joinDate: ZodOptional<ZodString>; rank: ZodOptional<ZodString>; user: ZodObject<{ username: ZodString; }, "strip", ZodTypeAny, { username: string; }, { username: string; }>; }, "passthrough", ZodTypeAny, objectOutputType<{ joinDate: ZodOptional<ZodString>; rank: ZodOptional<ZodString>; user: ZodObject<{ username: ...; }, "strip", ZodTypeAny, { username: ...; }, { username: ...; }>; }, ZodTypeAny, "passthrough">, objectInputType<{ joinDate: ZodOptional<ZodString>; rank: ZodOptional<ZodString>; user: ZodObject<{ username: ...; }, "strip", ZodTypeAny, { username: ...; }, { username: ...; }>; }, ZodTypeAny, "passthrough">>, "many">>; name: ZodOptional<ZodString>; owner: ZodOptional<ZodObject<{ username: ZodString; }, "strip", ZodTypeAny, { username: string; }, { username: string; }>>; tag: ZodOptional<ZodString>; trophies: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null>

Inherited from

PikaNetworkFeatureSet.getClan

---

getClans()

getClans(
   clanNames: string[], 
   config?: RequestConfig, 
   options?: BatchOptions): Promise<BatchResult<
  | objectOutputType<{
  createdAt: ZodOptional<ZodUnion<[ZodNumber, ZodString]>>;
  creationTime: ZodOptional<ZodString>;
  currentTrophies: ZodOptional<ZodNumber>;
  leveling: ZodOptional<ZodObject<{
     exp: ZodOptional<ZodNumber>;
     level: ZodOptional<ZodNumber>;
     totalExp: ZodOptional<ZodNumber>;
   }, "strip", ZodTypeAny, {
     exp?: number;
     level?: number;
     totalExp?: number;
   }, {
     exp?: number;
     level?: number;
     totalExp?: number;
  }>>;
  members: ZodOptional<ZodArray<ZodObject<{
     joinDate: ZodOptional<...>;
     rank: ZodOptional<...>;
     user: ZodObject<..., ..., ..., ..., ...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     joinDate: ...;
     rank: ...;
     user: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     joinDate: ...;
     rank: ...;
     user: ...;
  }, ZodTypeAny, "passthrough">>, "many">>;
  name: ZodOptional<ZodString>;
  owner: ZodOptional<ZodObject<{
     username: ZodString;
   }, "strip", ZodTypeAny, {
     username: string;
   }, {
     username: string;
  }>>;
  tag: ZodOptional<ZodString>;
  trophies: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">
| null>[]>;

Parameters

Parameter	Type
clanNames	string[]
config?	RequestConfig
options?	BatchOptions

Returns

Promise<BatchResult< | objectOutputType<{ createdAt: ZodOptional<ZodUnion<[ZodNumber, ZodString]>>; creationTime: ZodOptional<ZodString>; currentTrophies: ZodOptional<ZodNumber>; leveling: ZodOptional<ZodObject<{ exp: ZodOptional<ZodNumber>; level: ZodOptional<ZodNumber>; totalExp: ZodOptional<ZodNumber>; }, "strip", ZodTypeAny, { exp?: number; level?: number; totalExp?: number; }, { exp?: number; level?: number; totalExp?: number; }>>; members: ZodOptional<ZodArray<ZodObject<{ joinDate: ZodOptional<...>; rank: ZodOptional<...>; user: ZodObject<..., ..., ..., ..., ...>; }, "passthrough", ZodTypeAny, objectOutputType<{ joinDate: ...; rank: ...; user: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ joinDate: ...; rank: ...; user: ...; }, ZodTypeAny, "passthrough">>, "many">>; name: ZodOptional<ZodString>; owner: ZodOptional<ZodObject<{ username: ZodString; }, "strip", ZodTypeAny, { username: string; }, { username: string; }>>; tag: ZodOptional<ZodString>; trophies: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null>[]>

Inherited from

PikaNetworkFeatureSet.getClans

---

getLeaderboard()

getLeaderboard<G>(parameters: GetLeaderboardParams<G>, config?: RequestConfig): Promise<LeaderboardPage>;

Type Parameters

Type Parameter	Default type
G extends | "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"	| "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"

Parameters

Parameter	Type
parameters	GetLeaderboardParams<G>
config?	RequestConfig

Returns

Promise<LeaderboardPage>

Inherited from

PikaNetworkFeatureSet.getLeaderboard

---

getLeaderboards()

getLeaderboards(
   requests: GetLeaderboardParams<
  | "bedwars"
  | "dungeons"
  | "genpvp"
  | "kitpvp"
  | "oneblock"
  | "opfactions"
  | "oplifesteal"
  | "opprison"
  | "opskyblock"
  | "pillars"
  | "skymines"
  | "skypvp"
  | "survival"
  | "unrankedpractice">[], 
   config?: RequestConfig, 
options?: BatchOptions): Promise<BatchResult<LeaderboardPage>[]>;

Parameters

Parameter	Type
requests	GetLeaderboardParams< | "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice">[]
config?	RequestConfig
options?	BatchOptions

Returns

Promise<BatchResult<LeaderboardPage>[]>

Inherited from

PikaNetworkFeatureSet.getLeaderboards

---

getMatchRecap()

getMatchRecap(gameId: string, config?: RequestConfig): Promise<Record<string, unknown> | null>;

Parameters

Parameter	Type
gameId	string
config?	RequestConfig

Returns

Promise<Record<string, unknown> | null>

Inherited from

PikaNetworkFeatureSet.getMatchRecap

---

getProfile()

getProfile(username: string, config?: RequestConfig): Promise<
  | objectOutputType<{
  boosting: ZodOptional<ZodBoolean>;
  clan: ZodOptional<ZodNullable<ZodObject<{
     createdAt: ZodOptional<ZodUnion<[..., ...]>>;
     creationTime: ZodOptional<ZodString>;
     currentTrophies: ZodOptional<ZodNumber>;
     leveling: ZodOptional<ZodObject<{
        exp: ...;
        level: ...;
        totalExp: ...;
      }, "strip", ZodTypeAny, {
        exp?: ...;
        level?: ...;
        totalExp?: ...;
      }, {
        exp?: ...;
        level?: ...;
        totalExp?: ...;
     }>>;
     members: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
     name: ZodOptional<ZodString>;
     owner: ZodOptional<ZodObject<{
        username: ...;
      }, "strip", ZodTypeAny, {
        username: ...;
      }, {
        username: ...;
     }>>;
     tag: ZodOptional<ZodString>;
     trophies: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     createdAt: ZodOptional<ZodUnion<...>>;
     creationTime: ZodOptional<ZodString>;
     currentTrophies: ZodOptional<ZodNumber>;
     leveling: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     members: ZodOptional<ZodArray<..., ...>>;
     name: ZodOptional<ZodString>;
     owner: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     tag: ZodOptional<ZodString>;
     trophies: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     createdAt: ZodOptional<ZodUnion<...>>;
     creationTime: ZodOptional<ZodString>;
     currentTrophies: ZodOptional<ZodNumber>;
     leveling: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     members: ZodOptional<ZodArray<..., ...>>;
     name: ZodOptional<ZodString>;
     owner: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     tag: ZodOptional<ZodString>;
     trophies: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>>>;
  discord_boosting: ZodOptional<ZodBoolean>;
  discord_verified: ZodOptional<ZodBoolean>;
  email_verified: ZodOptional<ZodBoolean>;
  friends: ZodOptional<ZodArray<ZodObject<{
     username: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     username: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     username: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">>;
  lastSeen: ZodOptional<ZodNumber>;
  rank: ZodOptional<ZodObject<{
     experience: ZodOptional<ZodNumber>;
     level: ZodOptional<ZodNumber>;
     percentage: ZodOptional<ZodNumber>;
     rankDisplay: ZodOptional<ZodString>;
   }, "strip", ZodTypeAny, {
     experience?: number;
     level?: number;
     percentage?: number;
     rankDisplay?: string;
   }, {
     experience?: number;
     level?: number;
     percentage?: number;
     rankDisplay?: string;
  }>>;
  ranks: ZodOptional<ZodArray<ZodObject<{
     displayName: ZodOptional<ZodString>;
     expiry: ZodOptional<ZodNumber>;
     name: ZodOptional<ZodString>;
     season: ZodOptional<ZodNullable<ZodString>>;
     server: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     displayName: ZodOptional<ZodString>;
     expiry: ZodOptional<ZodNumber>;
     name: ZodOptional<ZodString>;
     season: ZodOptional<ZodNullable<...>>;
     server: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     displayName: ZodOptional<ZodString>;
     expiry: ZodOptional<ZodNumber>;
     name: ZodOptional<ZodString>;
     season: ZodOptional<ZodNullable<...>>;
     server: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  username: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">
| null>;

Parameters

Parameter	Type
username	string
config?	RequestConfig

Returns

Promise< | objectOutputType<{ boosting: ZodOptional<ZodBoolean>; clan: ZodOptional<ZodNullable<ZodObject<{ createdAt: ZodOptional<ZodUnion<[..., ...]>>; creationTime: ZodOptional<ZodString>; currentTrophies: ZodOptional<ZodNumber>; leveling: ZodOptional<ZodObject<{ exp: ...; level: ...; totalExp: ...; }, "strip", ZodTypeAny, { exp?: ...; level?: ...; totalExp?: ...; }, { exp?: ...; level?: ...; totalExp?: ...; }>>; members: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; name: ZodOptional<ZodString>; owner: ZodOptional<ZodObject<{ username: ...; }, "strip", ZodTypeAny, { username: ...; }, { username: ...; }>>; tag: ZodOptional<ZodString>; trophies: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ createdAt: ZodOptional<ZodUnion<...>>; creationTime: ZodOptional<ZodString>; currentTrophies: ZodOptional<ZodNumber>; leveling: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; members: ZodOptional<ZodArray<..., ...>>; name: ZodOptional<ZodString>; owner: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; tag: ZodOptional<ZodString>; trophies: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ createdAt: ZodOptional<ZodUnion<...>>; creationTime: ZodOptional<ZodString>; currentTrophies: ZodOptional<ZodNumber>; leveling: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; members: ZodOptional<ZodArray<..., ...>>; name: ZodOptional<ZodString>; owner: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; tag: ZodOptional<ZodString>; trophies: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>>>; discord_boosting: ZodOptional<ZodBoolean>; discord_verified: ZodOptional<ZodBoolean>; email_verified: ZodOptional<ZodBoolean>; friends: ZodOptional<ZodArray<ZodObject<{ username: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ username: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ username: ZodString; }, ZodTypeAny, "passthrough">>, "many">>; lastSeen: ZodOptional<ZodNumber>; rank: ZodOptional<ZodObject<{ experience: ZodOptional<ZodNumber>; level: ZodOptional<ZodNumber>; percentage: ZodOptional<ZodNumber>; rankDisplay: ZodOptional<ZodString>; }, "strip", ZodTypeAny, { experience?: number; level?: number; percentage?: number; rankDisplay?: string; }, { experience?: number; level?: number; percentage?: number; rankDisplay?: string; }>>; ranks: ZodOptional<ZodArray<ZodObject<{ displayName: ZodOptional<ZodString>; expiry: ZodOptional<ZodNumber>; name: ZodOptional<ZodString>; season: ZodOptional<ZodNullable<ZodString>>; server: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ displayName: ZodOptional<ZodString>; expiry: ZodOptional<ZodNumber>; name: ZodOptional<ZodString>; season: ZodOptional<ZodNullable<...>>; server: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ displayName: ZodOptional<ZodString>; expiry: ZodOptional<ZodNumber>; name: ZodOptional<ZodString>; season: ZodOptional<ZodNullable<...>>; server: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">>; username: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null>

Inherited from

PikaNetworkFeatureSet.getProfile

---

getProfiles()

getProfiles(
   usernames: string[], 
   config?: RequestConfig, 
   options?: BatchOptions): Promise<BatchResult<
  | objectOutputType<{
  boosting: ZodOptional<ZodBoolean>;
  clan: ZodOptional<ZodNullable<ZodObject<{
     createdAt: ZodOptional<...>;
     creationTime: ZodOptional<...>;
     currentTrophies: ZodOptional<...>;
     leveling: ZodOptional<...>;
     members: ZodOptional<...>;
     name: ZodOptional<...>;
     owner: ZodOptional<...>;
     tag: ZodOptional<...>;
     trophies: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     createdAt: ...;
     creationTime: ...;
     currentTrophies: ...;
     leveling: ...;
     members: ...;
     name: ...;
     owner: ...;
     tag: ...;
     trophies: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     createdAt: ...;
     creationTime: ...;
     currentTrophies: ...;
     leveling: ...;
     members: ...;
     name: ...;
     owner: ...;
     tag: ...;
     trophies: ...;
  }, ZodTypeAny, "passthrough">>>>;
  discord_boosting: ZodOptional<ZodBoolean>;
  discord_verified: ZodOptional<ZodBoolean>;
  email_verified: ZodOptional<ZodBoolean>;
  friends: ZodOptional<ZodArray<ZodObject<{
     username: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     username: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     username: ...;
  }, ZodTypeAny, "passthrough">>, "many">>;
  lastSeen: ZodOptional<ZodNumber>;
  rank: ZodOptional<ZodObject<{
     experience: ZodOptional<ZodNumber>;
     level: ZodOptional<ZodNumber>;
     percentage: ZodOptional<ZodNumber>;
     rankDisplay: ZodOptional<ZodString>;
   }, "strip", ZodTypeAny, {
     experience?: number;
     level?: number;
     percentage?: number;
     rankDisplay?: string;
   }, {
     experience?: number;
     level?: number;
     percentage?: number;
     rankDisplay?: string;
  }>>;
  ranks: ZodOptional<ZodArray<ZodObject<{
     displayName: ZodOptional<...>;
     expiry: ZodOptional<...>;
     name: ZodOptional<...>;
     season: ZodOptional<...>;
     server: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     displayName: ...;
     expiry: ...;
     name: ...;
     season: ...;
     server: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     displayName: ...;
     expiry: ...;
     name: ...;
     season: ...;
     server: ...;
  }, ZodTypeAny, "passthrough">>, "many">>;
  username: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">
| null>[]>;

Parameters

Parameter	Type
usernames	string[]
config?	RequestConfig
options?	BatchOptions

Returns

Promise<BatchResult< | objectOutputType<{ boosting: ZodOptional<ZodBoolean>; clan: ZodOptional<ZodNullable<ZodObject<{ createdAt: ZodOptional<...>; creationTime: ZodOptional<...>; currentTrophies: ZodOptional<...>; leveling: ZodOptional<...>; members: ZodOptional<...>; name: ZodOptional<...>; owner: ZodOptional<...>; tag: ZodOptional<...>; trophies: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ createdAt: ...; creationTime: ...; currentTrophies: ...; leveling: ...; members: ...; name: ...; owner: ...; tag: ...; trophies: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ createdAt: ...; creationTime: ...; currentTrophies: ...; leveling: ...; members: ...; name: ...; owner: ...; tag: ...; trophies: ...; }, ZodTypeAny, "passthrough">>>>; discord_boosting: ZodOptional<ZodBoolean>; discord_verified: ZodOptional<ZodBoolean>; email_verified: ZodOptional<ZodBoolean>; friends: ZodOptional<ZodArray<ZodObject<{ username: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ username: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ username: ...; }, ZodTypeAny, "passthrough">>, "many">>; lastSeen: ZodOptional<ZodNumber>; rank: ZodOptional<ZodObject<{ experience: ZodOptional<ZodNumber>; level: ZodOptional<ZodNumber>; percentage: ZodOptional<ZodNumber>; rankDisplay: ZodOptional<ZodString>; }, "strip", ZodTypeAny, { experience?: number; level?: number; percentage?: number; rankDisplay?: string; }, { experience?: number; level?: number; percentage?: number; rankDisplay?: string; }>>; ranks: ZodOptional<ZodArray<ZodObject<{ displayName: ZodOptional<...>; expiry: ZodOptional<...>; name: ZodOptional<...>; season: ZodOptional<...>; server: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ displayName: ...; expiry: ...; name: ...; season: ...; server: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ displayName: ...; expiry: ...; name: ...; season: ...; server: ...; }, ZodTypeAny, "passthrough">>, "many">>; username: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null>[]>

Inherited from

PikaNetworkFeatureSet.getProfiles

---

getProfileStat()

getProfileStat<G>(
   parameters: GetProfileStatsParams<G>, 
   statKey: 
  | string
  | PikaNetworkStatKey<G>, 
config?: RequestConfig): Promise<ProfileStat | null>;

Type Parameters

Type Parameter	Default type
G extends | "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"	| "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"

Parameters

Parameter	Type
parameters	GetProfileStatsParams<G>
statKey	| string | PikaNetworkStatKey<G>
config?	RequestConfig

Returns

Promise<ProfileStat | null>

Inherited from

PikaNetworkFeatureSet.getProfileStat

---

getProfileStats()

getProfileStats<G>(parameters: GetProfileStatsParams<G>, config?: RequestConfig): Promise<ProfileStats>;

Type Parameters

Type Parameter	Default type
G extends | "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"	| "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"

Parameters

Parameter	Type
parameters	GetProfileStatsParams<G>
config?	RequestConfig

Returns

Promise<ProfileStats>

Inherited from

PikaNetworkFeatureSet.getProfileStats

---

getProfileStatsBatch()

getProfileStatsBatch(
   requests: GetProfileStatsParams<
  | "bedwars"
  | "dungeons"
  | "genpvp"
  | "kitpvp"
  | "oneblock"
  | "opfactions"
  | "oplifesteal"
  | "opprison"
  | "opskyblock"
  | "pillars"
  | "skymines"
  | "skypvp"
  | "survival"
  | "unrankedpractice">[], 
   config?: RequestConfig, 
options?: BatchOptions): Promise<BatchResult<ProfileStats>[]>;

Parameters

Parameter	Type
requests	GetProfileStatsParams< | "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice">[]
config?	RequestConfig
options?	BatchOptions

Returns

Promise<BatchResult<ProfileStats>[]>

Inherited from

PikaNetworkFeatureSet.getProfileStatsBatch

---

getTotals()

getTotals<G>(parameters: GetTotalsParams<G>, config?: RequestConfig): Promise<object[]>;

Type Parameters

Type Parameter	Default type
G extends | "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"	| "bedwars" | "dungeons" | "genpvp" | "kitpvp" | "oneblock" | "opfactions" | "oplifesteal" | "opprison" | "opskyblock" | "pillars" | "skymines" | "skypvp" | "survival" | "unrankedpractice"

Parameters

Parameter	Type
parameters	GetTotalsParams<G>
config?	RequestConfig

Returns

Promise<object[]>

Inherited from

PikaNetworkFeatureSet.getTotals

---

invalidate()

invalidate(cacheKey: string): Promise<void>;

Purges a specific key from the cache.

Parameters

Parameter	Type
cacheKey	string

Returns

Promise<void>

Inherited from

PikaNetworkFeatureSet.invalidate

---

ping()

ping(config?: RequestConfig): Promise<boolean>;

Parameters

Parameter	Type
config?	RequestConfig

Returns

Promise<boolean>

Inherited from

PikaNetworkFeatureSet.ping