Interface PlayerGuildData

Holds information about a players Guild

interface PlayerGuildData {
    name: null | string;
    rank: null | GuildRank;
    fetch(options?): Promise<Guild>;
}

Index

Properties

Methods

Properties

`Readonly` name

name: null | string

The name of the player's Guild, if applicable

rank

rank: null | GuildRank

The player's rank in the Guild, if applicable

Methods

fetch

fetch(options?): Promise<Guild>
Returns the API object of the Guild, if applicable

This method causes API requests.
Parameters
- Optional options: GuildRequestOptions
  The options for the request; the field guild has no effect
Returns Promise<Guild>

Generated using TypeDoc