Lightcord/LightcordApi/docs/interfaces/_types_discorddispatchertyp...

773 lines
45 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DispatcherTypes | lightcordapi</title>
<meta name="description" content="Documentation for lightcordapi">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">lightcordapi</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>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_types_discorddispatchertypes_.html">&quot;types/DiscordDispatcherTypes&quot;</a>
</li>
<li>
<a href="_types_discorddispatchertypes_.dispatchertypes.html">DispatcherTypes</a>
</li>
</ul>
<h1>Interface DispatcherTypes</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DispatcherTypes</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="_types_discorddispatchertypes_.dispatchertypes.html#_computeorderedactionhandlers" class="tsd-kind-icon">_compute<wbr>Ordered<wbr>Action<wbr>Handlers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_computeorderedcallbacktokens" class="tsd-kind-icon">_compute<wbr>Ordered<wbr>Callback<wbr>Tokens</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_currentdispatchactiontype" class="tsd-kind-icon">_current<wbr>Dispatch<wbr>Action<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_dependencygraph" class="tsd-kind-icon">_dependency<wbr>Graph</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_invalidatecaches" class="tsd-kind-icon">_invalidate<wbr>Caches</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_lastid" class="tsd-kind-icon">_lastID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_orderedactionhandlers" class="tsd-kind-icon">_ordered<wbr>Action<wbr>Handlers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_orderedcallbacktokens" class="tsd-kind-icon">_ordered<wbr>Callback<wbr>Tokens</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_processwaitqueue" class="tsd-kind-icon">_process<wbr>Wait<wbr>Queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_processingwaitqueue" class="tsd-kind-icon">_processing<wbr>Wait<wbr>Queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_subscriptions" class="tsd-kind-icon">_subscriptions</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#_waitqueue" class="tsd-kind-icon">_wait<wbr>Queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#adddependencies" class="tsd-kind-icon">add<wbr>Dependencies</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="_types_discorddispatchertypes_.dispatchertypes.html#_dispatch" class="tsd-kind-icon">_dispatch</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#dirtydispatch" class="tsd-kind-icon">dirty<wbr>Dispatch</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#dispatch" class="tsd-kind-icon">dispatch</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#isdispatching" class="tsd-kind-icon">is<wbr>Dispatching</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#maybedispatch" class="tsd-kind-icon">maybe<wbr>Dispatch</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#register" class="tsd-kind-icon">register</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#setinterceptor" class="tsd-kind-icon">set<wbr>Interceptor</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#subscribe" class="tsd-kind-icon">subscribe</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_discorddispatchertypes_.dispatchertypes.html#wait" class="tsd-kind-icon">wait</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 name="_computeorderedactionhandlers" class="tsd-anchor"></a>
<h3>_compute<wbr>Ordered<wbr>Action<wbr>Handlers</h3>
<div class="tsd-signature tsd-kind-icon">_compute<wbr>Ordered<wbr>Action<wbr>Handlers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:44</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_computeorderedcallbacktokens" class="tsd-anchor"></a>
<h3>_compute<wbr>Ordered<wbr>Callback<wbr>Tokens</h3>
<div class="tsd-signature tsd-kind-icon">_compute<wbr>Ordered<wbr>Callback<wbr>Tokens<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:45</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_currentdispatchactiontype" class="tsd-anchor"></a>
<h3>_current<wbr>Dispatch<wbr>Action<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">_current<wbr>Dispatch<wbr>Action<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:5</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_dependencygraph" class="tsd-anchor"></a>
<h3>_dependency<wbr>Graph</h3>
<div class="tsd-signature tsd-kind-icon">_dependency<wbr>Graph<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:9</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_invalidatecaches" class="tsd-anchor"></a>
<h3>_invalidate<wbr>Caches</h3>
<div class="tsd-signature tsd-kind-icon">_invalidate<wbr>Caches<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:42</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_lastid" class="tsd-anchor"></a>
<h3>_lastID</h3>
<div class="tsd-signature tsd-kind-icon">_lastID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:8</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_orderedactionhandlers" class="tsd-anchor"></a>
<h3>_ordered<wbr>Action<wbr>Handlers</h3>
<div class="tsd-signature tsd-kind-icon">_ordered<wbr>Action<wbr>Handlers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:6</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_orderedcallbacktokens" class="tsd-anchor"></a>
<h3>_ordered<wbr>Callback<wbr>Tokens</h3>
<div class="tsd-signature tsd-kind-icon">_ordered<wbr>Callback<wbr>Tokens<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:7</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_processwaitqueue" class="tsd-anchor"></a>
<h3>_process<wbr>Wait<wbr>Queue</h3>
<div class="tsd-signature tsd-kind-icon">_process<wbr>Wait<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:43</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_processingwaitqueue" class="tsd-anchor"></a>
<h3>_processing<wbr>Wait<wbr>Queue</h3>
<div class="tsd-signature tsd-kind-icon">_processing<wbr>Wait<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:4</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_subscriptions" class="tsd-anchor"></a>
<h3>_subscriptions</h3>
<div class="tsd-signature tsd-kind-icon">_subscriptions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:2</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_waitqueue" class="tsd-anchor"></a>
<h3>_wait<wbr>Queue</h3>
<div class="tsd-signature tsd-kind-icon">_wait<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:3</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="adddependencies" class="tsd-anchor"></a>
<h3>add<wbr>Dependencies</h3>
<div class="tsd-signature tsd-kind-icon">add<wbr>Dependencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:41</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 name="_dispatch" class="tsd-anchor"></a>
<h3>_dispatch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">_dispatch<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:25</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Same as dispatcher.dispatch</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="dirtydispatch" class="tsd-anchor"></a>
<h3>dirty<wbr>Dispatch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">dirty<wbr>Dispatch<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:19</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Wait until the dispatcher finished dispatching, then dispatch</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="dispatch" class="tsd-anchor"></a>
<h3>dispatch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">dispatch<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:23</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>dispatch</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="isdispatching" class="tsd-anchor"></a>
<h3>is<wbr>Dispatching</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">is<wbr>Dispatching<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/types/DiscordDispatcherTypes.ts:11</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="maybedispatch" class="tsd-anchor"></a>
<h3>maybe<wbr>Dispatch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">maybe<wbr>Dispatch<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:15</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the dispatcher isn&#39;t dispatching, then dispatch</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="register" class="tsd-anchor"></a>
<h3>register</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, actionHandler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, storeDidChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:40</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>actionHandler: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>storeDidChange: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="setinterceptor" class="tsd-anchor"></a>
<h3>set<wbr>Interceptor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">set<wbr>Interceptor<span class="tsd-signature-symbol">(</span>interceptor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:29</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Intercept events before they happens, if returning true, then the event will be blocked from dispatching.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>interceptor: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="subscribe" class="tsd-anchor"></a>
<h3>subscribe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:35</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Subscribe to an event</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="unsubscribe" class="tsd-anchor"></a>
<h3>unsubscribe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:39</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unsubscribe from the event.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="wait" class="tsd-anchor"></a>
<h3>wait</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">wait<span class="tsd-signature-symbol">(</span>waiting<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><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 lightcordapi/src/types/DiscordDispatcherTypes.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Wait until the dispatcher has finished dispatching</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>waiting: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_types_discorddispatchertypes_.html">&quot;types/<wbr>Discord<wbr>Dispatcher<wbr>Types&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="_types_discorddispatchertypes_.dispatchertypes.html" class="tsd-kind-icon">Dispatcher<wbr>Types</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_computeorderedactionhandlers" class="tsd-kind-icon">_compute<wbr>Ordered<wbr>Action<wbr>Handlers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_computeorderedcallbacktokens" class="tsd-kind-icon">_compute<wbr>Ordered<wbr>Callback<wbr>Tokens</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_currentdispatchactiontype" class="tsd-kind-icon">_current<wbr>Dispatch<wbr>Action<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_dependencygraph" class="tsd-kind-icon">_dependency<wbr>Graph</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_invalidatecaches" class="tsd-kind-icon">_invalidate<wbr>Caches</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_lastid" class="tsd-kind-icon">_lastID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_orderedactionhandlers" class="tsd-kind-icon">_ordered<wbr>Action<wbr>Handlers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_orderedcallbacktokens" class="tsd-kind-icon">_ordered<wbr>Callback<wbr>Tokens</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_processwaitqueue" class="tsd-kind-icon">_process<wbr>Wait<wbr>Queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_processingwaitqueue" class="tsd-kind-icon">_processing<wbr>Wait<wbr>Queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_subscriptions" class="tsd-kind-icon">_subscriptions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_waitqueue" class="tsd-kind-icon">_wait<wbr>Queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#adddependencies" class="tsd-kind-icon">add<wbr>Dependencies</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#_dispatch" class="tsd-kind-icon">_dispatch</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#dirtydispatch" class="tsd-kind-icon">dirty<wbr>Dispatch</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#dispatch" class="tsd-kind-icon">dispatch</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#isdispatching" class="tsd-kind-icon">is<wbr>Dispatching</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#maybedispatch" class="tsd-kind-icon">maybe<wbr>Dispatch</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#register" class="tsd-kind-icon">register</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#setinterceptor" class="tsd-kind-icon">set<wbr>Interceptor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#subscribe" class="tsd-kind-icon">subscribe</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_discorddispatchertypes_.dispatchertypes.html#wait" class="tsd-kind-icon">wait</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<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>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</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/js/main.js"></script>
</body>
</html>