Options
All
  • Public
  • Public/Protected
  • All
Menu

gavel-gateway-js - v2.0.1

Index

Classes

Interfaces

Type aliases

Variables

Functions Endpoint

Functions Util

Type aliases

AttackSpeed

AttackSpeed: "SUPER_FAST" | "VERY_FAST" | "FAST" | "NORMAL" | "SLOW" | "VERY_SLOW" | "SUPER_SLOW"

A weapon attack speed

BannerPattern

BannerPattern: "bs" | "ts" | "ls" | "rs" | "ms" | "cs" | "drs" | "dls" | "ss" | "cr" | "sc" | "ld" | "rud" | "lud" | "rd" | "vh" | "vhr" | "hh" | "hhb" | "bl" | "br" | "tl" | "tr" | "bt" | "tt" | "bts" | "tts" | "mc" | "mr" | "bo" | "cbo" | "bri" | "gra" | "gru" | "cre" | "sku" | "flo" | "moj" | "glb" | "pig"

A banner pattern as defined by Minecraft

ClassType

ClassType: "ARCHER" | "ASSASSIN" | "DARK_WIZARD" | "HUNTER" | "KNIGHT" | "MAGE" | "NINJA" | "SHAMAN" | "SKYSEER" | "WARRIOR"

A type of player class

CraftableItemType

CraftableItemType: "BOOTS" | "BOW" | "BRACELET" | "CHESTPLATE" | "DAGGER" | "FOOD" | "HELMET" | "NECKLACE" | "LEGGINGS" | "POTION" | "RELIK" | "RING" | "SCROLL" | "SPEAR" | "WAND"

A specific type of item craftable using professions

CraftingSkill

CraftingSkill: "ARMORING" | "ALCHEMISM" | "COOKING" | "JEWELING" | "SCRIBING" | "TAILORING" | "WEAPONSMITHING" | "WOODWORKING"

A crafting profession skill

DonatorRank

DonatorRank: "CHAMPION" | "HERO" | "VIP+" | "VIP"

A donator rank on Wynncraft

GuildRank

GuildRank: "OWNER" | "CHIEF" | "STRATEGIST" | "CAPTAIN" | "RECRUITER" | "RECRUIT"

A rank in a guild

IdentificationName

IdentificationName: "STRENGTH" | "DEXTERITY" | "INTELLIGENCE" | "DEFENCE" | "AGILITY" | "MAIN_ATTACK_DAMAGE_PERCENT" | "MAIN_ATTACK_DAMAGE_RAW" | "SPELL_DAMAGE_PERCENT" | "SPELL_DAMAGE_RAW" | "RAINBOW_SPELL_DAMAGE_RAW" | "EARTH_DAMAGE" | "THUNDER_DAMAGE" | "WATER_DAMAGE" | "FIRE_DAMAGE" | "AIR_DAMAGE" | "EARTH_DEFENCE" | "THUNDER_DEFENCE" | "WATER_DEFENCE" | "FIRE_DEFENCE" | "AIR_DEFENCE" | "HEALTH_REGEN_PERCENT" | "HEALTH_REGEN_RAW" | "HEALTH" | "LIFE_STEAL" | "MANA_REGEN" | "MANA_STEAL" | "SPELL_COST_PCT_1" | "SPELL_COST_RAW_1" | "SPELL_COST_PCT_2" | "SPELL_COST_RAW_2" | "SPELL_COST_PCT_3" | "SPELL_COST_RAW_3" | "SPELL_COST_PCT_4" | "SPELL_COST_RAW_4" | "ATTACK_SPEED" | "POISON" | "THORNS" | "REFLECTION" | "EXPLODING" | "JUMP_HEIGHT" | "WALK_SPEED" | "SPRINT_DURATION" | "SPRINT_REGEN" | "SOUL_POINT_REGEN" | "GATHERING_SPEED" | "GATHERING_XP_BONUS" | "XP_BONUS" | "LOOT_BONUS" | "LOOT_QUALITY" | "STEALING"

A name for an item identification

ItemCategory

ItemCategory: "ARMOR" | "WEAPON" | "ACCESSORY"

A category to search items or recipes by

ItemDropType

ItemDropType: "NEVER" | "NORMAL" | "DUNGEON" | "LOOTCHEST"

A source an item can be obtained from

ItemRarity

ItemRarity: "MYTHIC" | "FABLED" | "LEGENDARY" | "RARE" | "SET" | "UNIQUE" | "NORMAL"

An item rarity tier

ItemRestriction

ItemRestriction: "UNTRADABLE" | "QUEST"

A restriction put on an item

ItemSpriteName

ItemSpriteName: "PLAYER_HEAD" | "LEATHER_HELMET" | "LEATHER_CHESTPLATE" | "LEATHER_LEGGINGS" | "LEATHER_BOOTS" | "GOLDEN_HELMET" | "GOLDEN_CHESTPLATE" | "GOLDEN_LEGGINGS" | "GOLDEN_BOOTS" | "CHAIN_HELMET" | "CHAIN_CHESTPLATE" | "CHAIN_LEGGINGS" | "CHAIN_BOOTS" | "IRON_HELMET" | "IRON_CHESTPLATE" | "IRON_LEGGINGS" | "IRON_BOOTS" | "DIAMOND_HELMET" | "DIAMOND_CHESTPLATE" | "DIAMOND_LEGGINGS" | "DIAMOND_BOOTS" | "WAND_DEFAULT_0" | "WAND_DEFAULT_1" | "WAND_DEFAULT_2" | "WAND_EARTH_0" | "WAND_EARTH_1" | "WAND_EARTH_2" | "WAND_THUNDER_0" | "WAND_THUNDER_1" | "WAND_THUNDER_2" | "WAND_WATER_0" | "WAND_WATER_1" | "WAND_WATER_2" | "WAND_FIRE_0" | "WAND_FIRE_1" | "WAND_FIRE_2" | "WAND_AIR_0" | "WAND_AIR_1" | "WAND_AIR_2" | "WAND_MULTI_0" | "WAND_MULTI_1" | "WAND_MULTI_2" | "SPEAR_DEFAULT_0" | "SPEAR_DEFAULT_1" | "SPEAR_EARTH_0" | "SPEAR_EARTH_1" | "SPEAR_EARTH_2" | "SPEAR_THUNDER_0" | "SPEAR_THUNDER_1" | "SPEAR_THUNDER_2" | "SPEAR_WATER_0" | "SPEAR_WATER_1" | "SPEAR_WATER_2" | "SPEAR_FIRE_0" | "SPEAR_FIRE_1" | "SPEAR_FIRE_2" | "SPEAR_AIR_0" | "SPEAR_AIR_1" | "SPEAR_AIR_2" | "SPEAR_MULTI_0" | "SPEAR_MULTI_1" | "SPEAR_MULTI_2" | "DAGGER_DEFAULT_0" | "DAGGER_DEFAULT_1" | "DAGGER_EARTH_0" | "DAGGER_EARTH_1" | "DAGGER_EARTH_2" | "DAGGER_THUNDER_0" | "DAGGER_THUNDER_1" | "DAGGER_THUNDER_2" | "DAGGER_WATER_0" | "DAGGER_WATER_1" | "DAGGER_WATER_2" | "DAGGER_FIRE_0" | "DAGGER_FIRE_1" | "DAGGER_FIRE_2" | "DAGGER_AIR_0" | "DAGGER_AIR_1" | "DAGGER_AIR_2" | "DAGGER_MULTI_0" | "DAGGER_MULTI_1" | "DAGGER_MULTI_2" | "BOW_DEFAULT_0" | "BOW_DEFAULT_1" | "BOW_EARTH_0" | "BOW_EARTH_1" | "BOW_EARTH_2" | "BOW_THUNDER_0" | "BOW_THUNDER_1" | "BOW_THUNDER_2" | "BOW_WATER_0" | "BOW_WATER_1" | "BOW_WATER_2" | "BOW_FIRE_0" | "BOW_FIRE_1" | "BOW_FIRE_2" | "BOW_AIR_0" | "BOW_AIR_1" | "BOW_AIR_2" | "BOW_MULTI_0" | "BOW_MULTI_1" | "BOW_MULTI_2" | "RELIK_DEFAULT_0" | "RELIK_DEFAULT_1" | "RELIK_EARTH_0" | "RELIK_EARTH_1" | "RELIK_EARTH_2" | "RELIK_THUNDER_0" | "RELIK_THUNDER_1" | "RELIK_THUNDER_2" | "RELIK_WATER_0" | "RELIK_WATER_1" | "RELIK_WATER_2" | "RELIK_FIRE_0" | "RELIK_FIRE_1" | "RELIK_FIRE_2" | "RELIK_AIR_0" | "RELIK_AIR_1" | "RELIK_AIR_2" | "RELIK_MULTI_0" | "RELIK_MULTI_1" | "RELIK_MULTI_2" | "RING_DEFAULT_0" | "RING_DEFAULT_1" | "RING_EARTH_0" | "RING_EARTH_1" | "RING_THUNDER_0" | "RING_THUNDER_1" | "RING_WATER_0" | "RING_WATER_1" | "RING_FIRE_0" | "RING_FIRE_1" | "RING_AIR_0" | "RING_AIR_1" | "RING_MULTI_0" | "RING_MULTI_1" | "RING_SPECIAL_0" | "RING_SPECIAL_1" | "RING_SPECIAL_2" | "BRACELET_DEFAULT_0" | "BRACELET_DEFAULT_1" | "BRACELET_EARTH_0" | "BRACELET_EARTH_1" | "BRACELET_THUNDER_0" | "BRACELET_THUNDER_1" | "BRACELET_WATER_0" | "BRACELET_WATER_1" | "BRACELET_FIRE_0" | "BRACELET_FIRE_1" | "BRACELET_AIR_0" | "BRACELET_AIR_1" | "BRACELET_MULTI_0" | "BRACELET_MULTI_1" | "NECKLACE_DEFAULT_0" | "NECKLACE_DEFAULT_1" | "NECKLACE_EARTH_0" | "NECKLACE_EARTH_1" | "NECKLACE_THUNDER_0" | "NECKLACE_THUNDER_1" | "NECKLACE_WATER_0" | "NECKLACE_WATER_1" | "NECKLACE_FIRE_0" | "NECKLACE_FIRE_1" | "NECKLACE_AIR_0" | "NECKLACE_AIR_1" | "NECKLACE_MULTI_0" | "NECKLACE_MULTI_1" | "NECKLACE_SPECIAL_0" | "NECKLACE_SPECIAL_1" | "NECKLACE_SPECIAL_2"

A sprite name commonly used by Wynncraft items

ItemType

ItemType: "BOOTS" | "LEGGINGS" | "CHESTPLATE" | "HELMET" | "SPEAR" | "WAND" | "BOW" | "DAGGER" | "RELIK" | "RING" | "BRACELET" | "NECKLACE"

All weapon, armor, and accessory types

MajorId

MajorId: "SAVIOURS_SACRIFICE" | "PEACEFUL_EFFIGY" | "FURIOUS_EFFIGY" | "PLAGUE" | "HAWKEYE" | "CHERRY_BOMBS" | "FLASHFREEZE" | "GREED" | "LIGHTWEIGHT" | "CAVALRYMAN" | "MAGNET" | "FISSION" | "RALLY" | "GUARDIAN" | "HEART_OF_THE_PACK" | "TRANSCENDENCE" | "ENTROPY" | "ROVING_ASSASSIN" | "GEOCENTRISM" | "FREERUNNER" | "MADNESS" | "SORCERY" | "EXPLOSIVE_IMPACT" | "TAUNT"

A name for an item major ID

MinecraftColor

MinecraftColor: "WHITE" | "LIGHT_GRAY" | "GRAY" | "BLACK" | "LIME" | "GREEN" | "CYAN" | "LIGHT_BLUE" | "BLUE" | "YELLOW" | "ORANGE" | "PINK" | "RED" | "MAGENTA" | "PURPLE" | "BROWN"

A color as used by Minecraft

MinecraftId

MinecraftId: MinecraftStringId | number

A value resolvable to a minecraft item id

MinecraftStringId

MinecraftStringId: `minecraft:${string}`

A value resolvable to a minecraft item id in string form

PlayerLeaderboardScope

PlayerLeaderboardScope: "TOTAL" | "SOLO"

A scope of leaderboard ranking

PlayerSoloLeaderboardType

PlayerSoloLeaderboardType: "COMBAT" | "PROFESSION" | "COMBINED" | "MINING" | "WOODCUTTING" | "FARMING" | "FISHING" | "SCRIBING" | "COOKING" | "ALCHEMISM" | "WOODWORKING" | "WEAPONSMITHING" | "TAILORING" | "ARMORING" | "JEWELING"

Player leaderboards available for solo

PlayerTotalLeaderboardType

PlayerTotalLeaderboardType: "PVP" | "COMBAT" | "PROFESSION" | "COMBINED"

Player leaderboards available for total

SemanticVersion

SemanticVersion: `${number}.${number}.${number}`

A semantic version identifier

ServerRank

ServerRank: "ADMINISTRATOR" | "MODERATOR" | "MEDIA" | "BUILDER" | "ITEM" | "GAME_MASTER" | "CMD" | "MUSIC" | "HYBRID" | "MEDIA" | "PLAYER"

A staff rank on Wynncraft

WorldType

WorldType: "WYNNCRAFT" | "MEDIA" | "OTHER"

A server type found on Wynncraft

WynncraftAPIRoute

WynncraftAPIRoute: `https://api.wynncraft.com/${string}` | `https://athena.wynntils.com/${string}`

A URL to a Wynncraft API resource

Variables

data

data: LocalData

A collection of static data that is used within the library, but can also be used externally

Endpoint Functions

fetchGuild

  • Fetches a guild from the API

    This function causes API requests.
    This function returns null if the guild doesn't exist.

    Parameters

    Returns Promise<Guild | null>

fetchGuildLeaderboard

  • Fetches the guild leaderboard from the API

    This function causes API requests.
    The list is ordered in ascending order of position. (first place at start)

    Parameters

    Returns Promise<List<LeaderboardGuild>>

fetchGuildList

  • Fetches all guild names from the API

    This function causes API requests.
    The list is ordered in ascending order of creation.

    Parameters

    Returns Promise<List<string>>

fetchIngredientList

  • Fetches all ingredient names from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<string>>

fetchIngredients

  • Fetches all ingredients matching the options from the API

    This function causes API requests.
    You should never disable caching for this function. Disabling caching or setting low cache times will result in multiple MB of network traffic on every call.

    Parameters

    Returns Promise<List<Ingredient>>

fetchItems

  • Fetches all items matching the options from the API

    This function causes API requests.
    You should never disable caching for this function. Disabling caching or setting low cache times will result in multiple MB of network traffic on every call.

    Parameters

    • Optional options: string | ItemSearchRequestOptions

      The options for the request, or a partial display name to search for

    Returns Promise<List<Item>>

fetchNames

  • Fetches the guild and player names matching this query from the API

    This function causes API requests.

    Parameters

    Returns Promise<NameSearch>

fetchOnlinePlayers

  • Fetches the online players from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<World>>

fetchOnlinePlayersSum

  • Fetches the number of online players from the API

    This function causes API requests.

    Parameters

    Returns Promise<OnlinePlayersSum>

fetchPlayer

  • Fetches a player from the API

    This function causes API requests.
    This function returns null if the player has never logged into Wynncraft.

    Parameters

    Returns Promise<Player | null>

fetchPlayerLeaderboard

fetchRaw

  • Returns a raw API response of the requested route

    This function causes API requests.

    Parameters

    Returns Promise<JSON>

fetchRecipeList

  • Fetches all recipe names from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<string>>

fetchRecipes

  • Fetches all recipes matching the options from the API

    This function causes API requests.
    You should never disable caching for this function. Disabling caching or setting low cache times will result in multiple MB of network traffic on every call.

    Parameters

    Returns Promise<List<Recipe>>

fetchTerritoryList

  • Fetches the territory list from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<Territory>>

Util Functions

flushCache

  • flushCache(): number

  • Removes all stored entries from cache and returns the amount of entries cleared

    Returns number

ratelimit

  • Returns information on the ratelimit channels

    Returns Ratelimit

setConfig

  • Merges the given options into the config and returns a copy of the full config

    Parameters

    • Optional config: ConfigOptions

      A ConfigOptions object containing all settings to be set

    Returns Config

Generated using TypeDoc