Skip to content

Commit

Permalink
docs: update documentation example
Browse files Browse the repository at this point in the history
  • Loading branch information
HunteRoi committed Mar 16, 2023
1 parent 185ea51 commit 1418c36
Show file tree
Hide file tree
Showing 25 changed files with 1,408 additions and 77 deletions.
18 changes: 18 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Launch Program",
"skipFiles": [
"<node_internals>/**"
],
"program": "${workspaceFolder}\\examples\\index.js",
"preLaunchTask": {
"type": "npm",
"script": "build"
}
}
]
}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Discord Mailbox is a framework to easily add a mailbox inside your bot. The feat
- Allow full customization of the embed (you can add image, thumbnail, etc)
- And much more!

![IMAGE](https://raw.githubusercontent.com/HunteRoi/discord-mailbox/master/assets/example.gif)
![v3 example](https://raw.githubusercontent.com/HunteRoi/discord-mailbox/master/assets/v3_example.gif)

See [./examples/index.js](https://github.com/hunteroi/discord-mailbox/tree/master/examples/index.js).
See [./examples/index.js](https://github.com/hunteroi/discord-mailbox/tree/master/examples/index.js). If you want to try this example, you need to send `createTicket` in your bot's DM.

## Prerequisites ⚠️

Expand Down
File renamed without changes
Binary file added assets/v3_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/api-docs/assets/search.js

Large diffs are not rendered by default.

56 changes: 28 additions & 28 deletions docs/api-docs/classes/InteractionBasedMailboxManager.html

Large diffs are not rendered by default.

66 changes: 33 additions & 33 deletions docs/api-docs/classes/MailboxManager.html

Large diffs are not rendered by default.

288 changes: 288 additions & 0 deletions docs/api-docs/classes/Ticket.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/api-docs/enums/MailboxManagerEvents.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1>Enumeration MailboxManagerEvents</h1></div>

<h3>Export</h3></div></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L7">MailboxManagerEvents.ts:7</a></li></ul></aside>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L7">MailboxManagerEvents.ts:7</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">
Expand All @@ -44,49 +44,49 @@ <h3 class="tsd-anchor-link"><span>reply<wbr/>Sent</span><a href="#replySent" ari
<div class="tsd-comment tsd-typography"><p>Emitted once a reply is sent for a ticket.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L32">MailboxManagerEvents.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L32">MailboxManagerEvents.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="threadCreate" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>thread<wbr/>Create</span><a href="#threadCreate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">thread<wbr/>Create<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;threadCreate&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Emitted once a thread is created for a ticket</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L28">MailboxManagerEvents.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L28">MailboxManagerEvents.ts:28</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ticketClose" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ticket<wbr/>Close</span><a href="#ticketClose" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ticket<wbr/>Close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ticketClose&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Emitted when a ticket is closed</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L19">MailboxManagerEvents.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L19">MailboxManagerEvents.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ticketCreate" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ticket<wbr/>Create</span><a href="#ticketCreate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ticket<wbr/>Create<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ticketCreate&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Emitted when a ticket is created</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L11">MailboxManagerEvents.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L11">MailboxManagerEvents.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ticketForceClose" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ticket<wbr/>Force<wbr/>Close</span><a href="#ticketForceClose" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ticket<wbr/>Force<wbr/>Close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ticketForceClose&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Emitted once a ticket is force-closed.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L36">MailboxManagerEvents.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L36">MailboxManagerEvents.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ticketLog" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ticket<wbr/>Log</span><a href="#ticketLog" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ticket<wbr/>Log<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ticketLog&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Emitted when a ticket is logged</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L23">MailboxManagerEvents.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L23">MailboxManagerEvents.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ticketUpdate" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ticket<wbr/>Update</span><a href="#ticketUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ticket<wbr/>Update<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ticketUpdate&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Emitted when a ticket is updated</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/e721d61/src/MailboxManagerEvents.ts#L15">MailboxManagerEvents.ts:15</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/hunteroi/discord-mailbox/blob/185ea51/src/MailboxManagerEvents.ts#L15">MailboxManagerEvents.ts:15</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit 1418c36

Please sign in to comment.