Skip to main content

Class: PlayerClan

Represents a Player's clan.

Constructors

constructor

new PlayerClan(client, data)

Parameters

NameType
clientClient
dataAPIPlayerClan

Defined in

struct/PlayerClan.ts:27

Properties

name

name: string

Name of the clan.

Defined in

struct/PlayerClan.ts:9


tag

tag: string

Tag of the clan.

Defined in

struct/PlayerClan.ts:12


level

level: null | number

Level of this clan.

This property is not available for ranked player's clan.

Defined in

struct/PlayerClan.ts:19


badge

badge: Badge

Badge of this clan.

Defined in

struct/PlayerClan.ts:22

Accessors

get shareLink(): string

Get clan's formatted link to open clan in-game.

Returns

string

Defined in

struct/PlayerClan.ts:41

Methods

fetch

fetch(options?): Promise<Clan>

Fetch detailed clan info for the player's clan.

Parameters

NameType
options?OverrideOptions

Returns

Promise<Clan>

Defined in

struct/PlayerClan.ts:36