@elara-services/leveling

Version:

A package for XP/Leveling on Discord.

elara-services-leveling.pages.dev

13 lines • 652 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>API | @elara-services/leveling</title><meta name="description" content="Documentation for @elara-services/leveling"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@elara-services/leveling</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@elara-services/leveling</a></li><li><a href="API.html">API</a></li></ul><h1>Class API</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li>API</li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/51e980b/leveling/src/services/api.ts#L50">src/services/api.ts:50</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="API.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg>constructor</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="API.html#_client" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>#client</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="API.html#servers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg>servers</a> <a href="API.html#users-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg>users</a> <a href="API.html#weekly-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg>weekly</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="API.html#_displayUser" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>#displayUser</a> <a href="API.html#_getServer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>#getServer</a> <a href="API.html#_getSettings" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>#getSettings</a> <a href="API.html#_getUser" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>#getUser</a> <a href="API.html#_handleIgnore" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>#handleIgnore</a> <a href="API.html#getLeaderboard" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getLeaderboard</a> <a href="API.html#getRankCard" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getRankCard</a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link" id="constructor.new_API">new API(client): <a href="API.html" class="tsd-signature-type tsd-kind-class">API</a><a href="#constructor.new_API" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>client: <a href="Leveling.html" class="tsd-signature-type tsd-kind-class">Leveling</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="API.html" class="tsd-signature-type tsd-kind-class">API</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/51e980b/leveling/src/services/api.ts#L52">src/services/api.ts:52</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="_client" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> #client<a href="#_client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature">#client: <a href="Leveling.html" class="tsd-signature-type tsd-kind-class">Leveling</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/51e980b/leveling/src/services/api.ts#L51">src/services/api.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="servers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">servers<a href="#servers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="servers.servers-1">get servers(): { announce: { setChannel: ((guildId, channelId) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); setMessage: ((guildId, type, options) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); toggle: ((guildId, type) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); }; cooldown: ((guildId, seconds, roles?) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); delete: ((guildId) => Promise<{ data: { data: null | <a href="../types/CachedOptions.html" class="tsd-signature-type tsd-kind-type-alias">CachedOptions</a><<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>>; users: <a href="../types/CachedOptions.html" class="tsd-signature-type tsd-kind-type-alias">CachedOptions</a><<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>>[]; weekly: <a href="../types/CachedOptions.html" class="tsd-signature-type tsd-kind-type-alias">CachedOptions</a><<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>>[]; }; message: string; status: boolean; }>); fetchAll: ((guildIds?) => Promise<{ message: string; status: false; } | { data: never[] | (FlattenMaps<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>> & { _id: ObjectId; })[]; status: true; }>); get: ((guildId) => Promise<{ message: string; status: false; } | { data: FlattenMaps<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a> & { _id: ObjectId; }>; status: true; }>); ignore: { channels: ((guildId, channels) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); roles: ((guildId, roles) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); users: ((guildId, users) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); }; import: ((guildId, targetGuildId, type?) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); leaderboard: { formatted: (<D>(guildId, options?, forceStatic?, board?) => Promise<{ message: string; status: false; } | <a href="../interfaces/LeaderboardFormattedResponse.html" class="tsd-signature-type tsd-kind-interface">LeaderboardFormattedResponse</a><<a href="../types/LeaderboardFormatted.html" class="tsd-signature-type tsd-kind-type-alias">LeaderboardFormatted</a>[]>>); get: (<D>(guildId, options?, board?) => Promise<{ message: string; status: false; } | <a href="../interfaces/LeaderboardFormattedResponse.html" class="tsd-signature-type tsd-kind-interface">LeaderboardFormattedResponse</a><<a href="../types/LeaderboardUser.html" class="tsd-signature-type tsd-kind-type-alias">LeaderboardUser</a>[]>>); setBackground: ((guildId, options) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); }; levels: { add: ((guildId, level, options?) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); addRoles: ((guildId, level, roles) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); get: ((guildId, level) => Promise<{ message: string; status: false; } | { data: { level: number; levelName: string; options: <a href="../types/Options.html" class="tsd-signature-type tsd-kind-type-alias">Options</a>; roles: { add: string[]; remove: string[]; }; }; status: true; }>); getLevelName: ((guildId, level) => Promise<{ message: string; status: true; }>); remove: ((guildId, level) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); removeRoles: ((guildId, level, roles) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); setMessage: ((guildId, options, level) => Promise<{ message: string; status: false; } | { message: string; status: true; }>); }; multipliers: { add: <span class="tsd-signatur