@elara-services/leveling

Version:

A package for XP/Leveling on Discord.

elara-services-leveling.pages.dev

24 lines • 120 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Leveling | @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="Leveling.html">Leveling</a></li></ul><h1>Class Leveling</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><a href="Database.html" class="tsd-signature-type tsd-kind-class">Database</a><ul class="tsd-hierarchy"><li>Leveling</li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/index.ts#L38">src/index.ts:38</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="Leveling.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="Leveling.html#_events" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>#events</a> <a href="Leveling.html#_listening" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>#listening</a> <a href="Leveling.html#_url" class="tsd-index-link tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>#url</a> <a href="Leveling.html#api" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>api</a> <a href="Leveling.html#client" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>client</a> <a href="Leveling.html#dbs" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>dbs</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="Leveling.html#weekly-1" class="tsd-index-link tsd-is-private tsd-is-inherited"><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="Leveling.html#_connect" class="tsd-index-link tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>#connect</a> <a href="Leveling.html#getOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getOptions</a> <a href="Leveling.html#guildMemberRemove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>guildMemberRemove</a> <a href="Leveling.html#handleLevelups" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>handleLevelups</a> <a href="Leveling.html#messageCreate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>messageCreate</a> <a href="Leveling.html#onCooldown" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>onCooldown</a> <a href="Leveling.html#onLevelUp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>onLevelUp</a> <a href="Leveling.html#onXP" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>onXP</a> <a href="Leveling.html#send" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>send</a> <a href="Leveling.html#sendOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>sendOptions</a> <a href="Leveling.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>start</a> <a href="Leveling.html#voiceStateUpdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>voiceStateUpdate</a> <a href="Leveling.html#webhook" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>webhook</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_Leveling">new Leveling(client, mongodbURI, dbName?): <a href="Leveling.html" class="tsd-signature-type tsd-kind-class">Leveling</a><a href="#constructor.new_Leveling" 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: Client<boolean></h5></li><li><h5>mongodbURI: string</h5></li><li><h5>dbName: string = "Leveling"</h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Leveling.html" class="tsd-signature-type tsd-kind-class">Leveling</a></h4><aside class="tsd-sources">Overrides <a href="Database.html">Database</a>.<a href="Database.html#constructor">constructor</a><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/index.ts#L48">src/index.ts:48</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="_events" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> #events<a href="#_events" 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">#events: __module = ...</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/index.ts#L47">src/index.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_listening" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> #listening<a href="#_listening" 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">#listening: boolean = false</div><div class="tsd-comment tsd-typography">A boolean to make sure the package only listens to the events ONCE </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/index.ts#L46">src/index.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="_url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> #url<a href="#_url" 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">#url: string</div><aside class="tsd-sources">Inherited from <a href="Database.html">Database</a>.<a href="Database.html#_url">#url</a><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/services/index.ts#L19">src/services/index.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link">api<a href="#api" 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">api: <a href="API.html" class="tsd-signature-type tsd-kind-class">API</a> = ...</div><div class="tsd-comment tsd-typography">The manager to configure the leveling data () </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/index.ts#L42">src/index.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="client" class="tsd-anchor"></a><h3 class="tsd-anchor-link">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: Client<boolean></div><aside class="tsd-sources">Inherited from <a href="Database.html">Database</a>.<a href="Database.html#client">client</a><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/index.ts#L49">src/index.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="dbs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">dbs<a href="#dbs" 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">dbs: { settings: Model<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, {}, {}, {}, Document<unknown, {}, <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>> & <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a> & { _id: ObjectId; }, Schema<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, Model<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, any, any, any, Document<unknown, any, <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>> & <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a> & { _id: ObjectId; }, any>, {}, {}, {}, {}, DefaultSchemaOptions, <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, Document<unknown, {}, FlatRecord<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>>> & FlatRecord<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>> & { _id: ObjectId; }>>; users: Model<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, {}, {}, {}, Document<unknown, {}, <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>> & <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a> & { _id: ObjectId; }, Schema<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, Model<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, any, any, any, Document<unknown, any, <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>> & <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a> & { _id: ObjectId; }, any>, {}, {}, {}, {}, DefaultSchemaOptions, <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, Document<unknown, {}, FlatRecord<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>>> & FlatRecord<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>> & { _id: ObjectId; }>>; weekly: Model<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, {}, {}, {}, Document<unknown, {}, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a> & { _id: ObjectId; }, Schema<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, Model<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, any, any, any, Document<unknown, any, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a> & { _id: ObjectId; }, any>, {}, {}, {}, {}, DefaultSchemaOptions, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, Document<unknown, {}, FlatRecord<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>>> & FlatRecord<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & { _id: ObjectId; }>>; } = ...</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>settings: Model<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, {}, {}, {}, Document<unknown, {}, <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>> & <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a> & { _id: ObjectId; }, Schema<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, Model<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, any, any, any, Document<unknown, any, <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>> & <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a> & { _id: ObjectId; }, any>, {}, {}, {}, {}, DefaultSchemaOptions, <a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>, Document<unknown, {}, FlatRecord<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>>> & FlatRecord<<a href="../interfaces/Settings.html" class="tsd-signature-type tsd-kind-interface">Settings</a>> & { _id: ObjectId; }>></h5></li><li class="tsd-parameter"><h5>users: Model<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, {}, {}, {}, Document<unknown, {}, <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>> & <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a> & { _id: ObjectId; }, Schema<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, Model<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, any, any, any, Document<unknown, any, <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>> & <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a> & { _id: ObjectId; }, any>, {}, {}, {}, {}, DefaultSchemaOptions, <a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>, Document<unknown, {}, FlatRecord<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>>> & FlatRecord<<a href="../interfaces/Users.html" class="tsd-signature-type tsd-kind-interface">Users</a>> & { _id: ObjectId; }>></h5></li><li class="tsd-parameter"><h5>weekly: Model<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, {}, {}, {}, Document<unknown, {}, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a> & { _id: ObjectId; }, Schema<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, Model<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, any, any, any, Document<unknown, any, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a> & { _id: ObjectId; }, any>, {}, {}, {}, {}, DefaultSchemaOptions, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>, Document<unknown, {}, FlatRecord<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>>> & FlatRecord<<a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & { _id: ObjectId; }>></h5></li></ul></div><aside class="tsd-sources">Inherited from <a href="Database.html">Database</a>.<a href="Database.html#dbs">dbs</a><ul><li>Defined in <a href="https://github.com/elara-bots/npm/blob/ce3a502/leveling/src/services/index.ts#L20">src/services/index.ts:20</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="weekly-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> weekly<a href="#weekly-1" 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 tsd-is-private tsd-is-inherited"><li class="tsd-signature" id="weekly-1.weekly-2">get weekly(): { add: ((guildId, data) => Promise<null | Document<unknown, {}, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a> & { _id: ObjectId; }>); get: ((guildId, id?) => Promise<null | Document<unknown, {}, <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a>> & <a href="../interfaces/Weekly.html" class="tsd-signature-type tsd-kind-interface">Weekly</a> & { _id: ObjectId; }>); <span class="tsd-signature-symb