Files
archived-handler/docs/interfaces/Sern.Wrapper.html
xxDeveloper 163e48f3eb feat(*): Revamp Docs (#47)
* style: Formatted 17 files & changes messageHelper util

* style: Formatted HTML and CSS files

* Revert "style: Formatted 17 files & changes messageHelper util"

This reverts commit 988d7fa6d2f07fadd05d1fc5a42c26d4767b0b44.

* style(style.css): Formatted main style file with tabwidth 2

* chore: Added docs maintainer

* chore: Changed typedoc configration

* chore(README.md): Removed coming soon from links

* chore: Updated Prettier formatter tab width

* docs(readme): Improved Readme readability

* docs(README): Fixed installation box

* style(README.md): Improved readability

* chore: Added CONTRIBUTING.md

* docs(README.md): Removed old repo link and it's line

* docs(README): Updated Intents to djs v14

Co-authored-by: EvolutionX <85353424+EvolutionX-10@users.noreply.github.com>

* docs: Updated README example to djs v14

* docs: Formatted README examples

* Update README.md

* docs: Updated organization description

* docs(README): Rename 'fixed' to 'patched'

* chore: Updated LICENSE

* chore: Updated LICNESE

* chore: Changed license to MIT

* Delete LICENSE.md

* chore: Recreated LICENSE

* chore: First License boilerplate preview

* style(index.ts): Added a space

* chore(index.ts): First license boilerplate preview

* chore(PRETTIER): Re-updated the tab width

* chore(SECURITY): Updated security.md file

* docs(README): Improved readability

* fix(README): Fixed typo

* style: Updated license boilerplate

* style(*): Updated license boilerplate

* style: Updated license boilerplate

* style: Updated license boilerplate

* style: Updated license boilerplate

* style: Updated License boilerplate

* style: Updated License boilerplate

* docs(README): Added stats

* docs(README): Temporarily or permanently removed stats

* refactor: DRY Principles

* feat: finished interactionCreate.ts handling? (need test)

* chore: Updated CONTRIBUTING.md file

* chore: Updated credits

* chore(NPM): Prepared package.json for release

* revert: Some changes

* revert: Revert back to MIT LICENSE (#50)

* chore: Updated LICENSE boilerplate

* style: Improved comments

* style: Updated comments

* fix: Non-exhaustiveness led to commands not registering readyEvent.ts

* feat: Add DefinetlyDefined type, more todo statements

* feat: Aliases optional

* feat: Optional plugins to reduce bloat

* feat: better looking typings for modules

* refactor: Simplify sernModule handler signature

* refactor: make ApplicationCommandOptions optional

* refactor: make description optional

* refactor: Bring CommandType and PluginType to top level

* fix: Fix return type of sernModule

* refactor: Why is that not assignable bruh

* revert: Re-add plugins overload

* fix(CODE_OF_CONDUCT): Removed unusual dot

* Update package.json

* fix: Resolve conflicts

* fix: Resolve conflicts

* feat: should be able to register other nodejs event emitters

* fix: Standard for of does not resolve promises. Switched to for await

* feat: Adding sern event listeners, overriding and typing methods

* feat: Edited event names for more conciseness, finished basic event emitters

* style: Run prettier

* fix: didn't run prettier, now i am

* fix: linting issue in markup.ts

* fix: prettier wants lf line ending

* fix: prettier changes again

* feat: add .prettierignore and ignore README.md

* feat: add externallyUsed.ts and support BothCommands again

* feat: remove comments about prev commit

* style: change prettier print width and reformat

* feat: adding modal and autocomplete support

* feat: Finishing up autocomplete, need to test

* feat: Making name required in auto cmp interactions

* feat: move name and description out of OptionsData[]

* feat: finishing optionData for autocomplete changes, adding class for builder

* feat: finishing autocomplete!!

* refactor: Simplifying logic of message filter

* feat: Adding docs to some data structures, moving to default from export files

* refactor: cleaning up code, removing unuseds

* feat: adding refactoring for repetitive event plugin processing

* feat: adding better typings, refactoring

* refactor: remove unnecessary nullish short circuit

* refactor: remove unnecessary nullish short circuit

* feat: add docs/ to npmignore

* style: Formatted 17 files & changes messageHelper util

* style: Formatted HTML and CSS files

* Revert "style: Formatted 17 files & changes messageHelper util"

This reverts commit 988d7fa6d2f07fadd05d1fc5a42c26d4767b0b44.

* style(style.css): Formatted main style file with tabwidth 2

* chore: Added docs maintainer

* chore: Changed typedoc configration

* chore(README.md): Removed coming soon from links

* docs(readme): Improved Readme readability

* chore: Added CONTRIBUTING.md

* docs(README): Fixed installation box

* style(README.md): Improved readability

* docs(README.md): Removed old repo link and it's line

* docs: Updated README example to djs v14

* docs(README): Updated Intents to djs v14

Co-authored-by: EvolutionX <85353424+EvolutionX-10@users.noreply.github.com>

* docs: Formatted README examples

* Update README.md

* chore: Updated LICENSE

* chore: Updated LICNESE

* chore: Changed license to MIT

* Delete LICENSE.md

* chore: Recreated LICENSE

* chore: First License boilerplate preview

* style(index.ts): Added a space

* chore(index.ts): First license boilerplate preview

* chore(SECURITY): Updated security.md file

* style: Updated license boilerplate

* docs(README): Added stats

* chore: Updated CONTRIBUTING.md file

* chore: Updated credits

* chore(NPM): Prepared package.json for release

* revert: Some changes

* revert: Revert back to MIT LICENSE (#50)

* fix(CODE_OF_CONDUCT): Removed unusual dot

* fix: Resolve conflicts

* fix: Resolve conflicts

Co-authored-by: EvolutionX <85353424+EvolutionX-10@users.noreply.github.com>
Co-authored-by: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
2022-05-30 20:54:23 +03:00

410 lines
18 KiB
HTML

<!DOCTYPE html>
<html class="default">
<head>
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="IE=edge" />
<title>Wrapper | sern-handler</title>
<meta name="description" content="Documentation for sern-handler" />
<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 async src="../assets/search.js" id="search-script"></script>
</head>
<body>
<script>
document.body.classList.add(localStorage.getItem('tsd-theme') || 'os');
</script>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label
><input type="text" id="tsd-search-field" />
</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">sern-handler</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked /><label
class="tsd-widget"
for="tsd-filter-inherited"
>Inherited</label
><input type="checkbox" id="tsd-filter-externals" checked /><label
class="tsd-widget"
for="tsd-filter-externals"
>Externals</label
>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">sern-handler</a></li>
<li><a href="../modules/Sern.html">Sern</a></li>
<li><a href="Sern.Wrapper.html">Wrapper</a></li>
</ul>
<h1>Interface Wrapper</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object to be passed into Sern.Handler constructor.</p>
</div>
<dl class="tsd-comment-tags">
<dt>property</dt>
<dd><p>{readonly Client} client</p></dd>
<dt>property</dt>
<dd><p>{readonly string} prefix</p></dd>
<dt>property</dt>
<dd><p>{readonly string} commands</p></dd>
<dt>prop</dt>
<dd><p>{(handler : Handler) =&gt; void)} init</p></dd>
<dt>property</dt>
<dd><p>{readonly {test: boolean, id: string}[]} privateServers</p></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li><span class="target">Wrapper</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#client" class="tsd-kind-icon">client</a>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#commands" class="tsd-kind-icon">commands</a>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#prefix" class="tsd-kind-icon">prefix</a>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#privateServers" class="tsd-kind-icon">private<wbr />Servers</a>
</li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#init" class="tsd-kind-icon">init</a>
</li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="client" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<span class="tsd-flag ts-flagReadonly">Readonly</span> client<a
href="#client"
aria-label="Permalink"
class="tsd-anchor-icon"
><svg
xmlns="http://www.w3.org/2000/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"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path>
<path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg
></a>
</h3>
<div class="tsd-signature tsd-kind-icon">
client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Client</span
><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span
><span class="tsd-signature-symbol">&gt;</span>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a href="https://github.com/sern-handler/Sern/blob/29d92ca/src/handler/sern.ts#L270"
>handler/sern.ts:270</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="commands" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<span class="tsd-flag ts-flagReadonly">Readonly</span> commands<a
href="#commands"
aria-label="Permalink"
class="tsd-anchor-icon"
><svg
xmlns="http://www.w3.org/2000/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"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path>
<path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg
></a>
</h3>
<div class="tsd-signature tsd-kind-icon">
commands<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a href="https://github.com/sern-handler/Sern/blob/29d92ca/src/handler/sern.ts#L272"
>handler/sern.ts:272</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="prefix" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<span class="tsd-flag ts-flagReadonly">Readonly</span> prefix<a
href="#prefix"
aria-label="Permalink"
class="tsd-anchor-icon"
><svg
xmlns="http://www.w3.org/2000/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"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path>
<path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg
></a>
</h3>
<div class="tsd-signature tsd-kind-icon">
prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a href="https://github.com/sern-handler/Sern/blob/29d92ca/src/handler/sern.ts#L271"
>handler/sern.ts:271</a
>
</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a id="privateServers" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<span class="tsd-flag ts-flagReadonly">Readonly</span> private<wbr />Servers<a
href="#privateServers"
aria-label="Permalink"
class="tsd-anchor-icon"
><svg
xmlns="http://www.w3.org/2000/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"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path>
<path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg
></a>
</h3>
<div class="tsd-signature tsd-kind-icon">
private<wbr />Servers<span class="tsd-signature-symbol">:</span>
<span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span
><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>test<span
class="tsd-signature-symbol"
>: </span
><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span
><span class="tsd-signature-symbol">[]</span>
</div>
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a href="https://github.com/sern-handler/Sern/blob/29d92ca/src/handler/sern.ts#L274"
>handler/sern.ts:274</a
>
</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a id="init" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<span class="tsd-flag ts-flagOptional">Optional</span> init<a
href="#init"
aria-label="Permalink"
class="tsd-anchor-icon"
><svg
xmlns="http://www.w3.org/2000/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"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path>
<path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg
></a>
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">
init<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">: </span
><a href="../classes/Sern.Handler.html" class="tsd-signature-type" data-tsd-kind="Class">Handler</a
><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span
><span class="tsd-signature-type">void</span>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>
Defined in
<a href="https://github.com/sern-handler/Sern/blob/29d92ca/src/handler/sern.ts#L273"
>handler/sern.ts:273</a
>
</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>
handler:
<a href="../classes/Sern.Handler.html" class="tsd-signature-type" data-tsd-kind="Class"
>Handler</a
>
</h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=""><a href="../modules.html">Exports</a></li>
<li class="current tsd-kind-namespace"><a href="../modules/Sern.html">Sern</a></li>
<li class="tsd-kind-namespace"><a href="../modules/Types.html">Types</a></li>
<li class="tsd-kind-namespace"><a href="../modules/Utils.html">Utils</a></li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
<a href="Sern.Wrapper.html" class="tsd-kind-icon">Wrapper</a>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#client" class="tsd-kind-icon">client</a>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#commands" class="tsd-kind-icon">commands</a>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#prefix" class="tsd-kind-icon">prefix</a>
</li>
<li class="tsd-kind-property tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#privateServers" class="tsd-kind-icon">private<wbr />Servers</a>
</li>
<li class="tsd-kind-method tsd-parent-kind-interface">
<a href="Sern.Wrapper.html#init" class="tsd-kind-icon">init</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
</div>
<h2>Settings</h2>
<p>
Theme
<select id="theme">
<option value="os">OS</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</p>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/main.js"></script>
</body>
</html>