Skip to content

Commit

Permalink
chore: examples in ts, switch from CJS to ECM, fix docs typos, remove…
Browse files Browse the repository at this point in the history 
… discord-logs for less internal coupling
  • Loading branch information
HunteRoi committed Jun 20, 2024
1 parent 6e1a1ea commit ef51215
Show file tree
Hide file tree
Showing 19 changed files with 207 additions and 401 deletions.
9 changes: 4 additions & 5 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Node
node_modules
node_modules/

# Compiled files
lib

# Tests
**test**
lib/
examples/index.js
examples/index2.js
6 changes: 3 additions & 3 deletions docs/api-docs/classes/ClientWithTempManager.html
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/api-docs/classes/TempChannelsManager.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/api-docs/enums/TempChannelsManagerEvents.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/api-docs/interfaces/ChildChannelData.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChildChannelData | @hunteroi/discord-temp-channels</title><meta name="description" content="Documentation for @hunteroi/discord-temp-channels"/><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/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/hunteroi/discord-temp-channels">GitHub</a><a href="https://github.com/hunteroi/discord-temp-channels/blob/master/BREAKING_CHANGES.md">Breaking Changes</a></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">@hunteroi/discord-temp-channels</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="../assets/icons.svg#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">@hunteroi/discord-temp-channels</a></li><li><a href="ChildChannelData.html">ChildChannelData</a></li></ul><h1>Interface ChildChannelData</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The data about a temporary channel ticket</p>
</div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ChildChannelData</p>
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ChildChannelData</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="ChildChannelData.html#owner">owner</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ChildChannelData.html#voiceChannel">voiceChannel</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VoiceChannel</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/hunteroi/discord-temp-channels/blob/9310533acb0d1820266f7024dc0515af983c9120/src/types/ChildChannelData.ts#L9">types/ChildChannelData.ts:9</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="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ChildChannelData.html#owner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a>
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ChildChannelData</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="ChildChannelData.html#owner">owner</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ChildChannelData.html#voiceChannel">voiceChannel</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VoiceChannel</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/hunteroi/discord-temp-channels/blob/6e1a1ea9647c658c1f65234168c160ba48284e06/src/types/ChildChannelData.ts#L9">types/ChildChannelData.ts:9</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="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ChildChannelData.html#owner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a>
<a href="ChildChannelData.html#voiceChannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>voice<wbr/>Channel</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="owner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>owner</span><a href="#owner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">GuildMember</span></div><div class="tsd-comment tsd-typography"><p>The owner of the ticket</p>
</div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ChildChannelData</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/hunteroi/discord-temp-channels/blob/9310533acb0d1820266f7024dc0515af983c9120/src/types/ChildChannelData.ts#L16">types/ChildChannelData.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="voiceChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>voice<wbr/>Channel</span><a href="#voiceChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">voice<wbr/>Channel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">VoiceChannel</span></div><div class="tsd-comment tsd-typography"><p>The created voice channel</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/hunteroi/discord-temp-channels/blob/6e1a1ea9647c658c1f65234168c160ba48284e06/src/types/ChildChannelData.ts#L16">types/ChildChannelData.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="voiceChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>voice<wbr/>Channel</span><a href="#voiceChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">voice<wbr/>Channel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">VoiceChannel</span></div><div class="tsd-comment tsd-typography"><p>The created voice channel</p>
</div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ChildChannelData</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/hunteroi/discord-temp-channels/blob/9310533acb0d1820266f7024dc0515af983c9120/src/types/ChildChannelData.ts#L24">types/ChildChannelData.ts:24</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#owner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a><a href="#voiceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>voice<wbr/>Channel</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@hunteroi/discord-temp-channels</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/hunteroi/discord-temp-channels/blob/6e1a1ea9647c658c1f65234168c160ba48284e06/src/types/ChildChannelData.ts#L24">types/ChildChannelData.ts:24</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#owner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a><a href="#voiceChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>voice<wbr/>Channel</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@hunteroi/discord-temp-channels</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
Loading

0 comments on commit ef51215

Please sign in to comment.