This repository has been archived on 2025-11-10. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
CommandBot/docs/modules.html
T

83 lines
64 KiB
HTML

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>commandbot</title><meta name="description" content="Documentation for commandbot"/><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><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">commandbot</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"><h1>commandbot</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/Bot.html" class="tsd-kind-icon">Bot</a></li><li class="tsd-kind-class"><a href="classes/ChatCommand.html" class="tsd-kind-icon">Chat<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-class"><a href="classes/CommandManager.html" class="tsd-kind-icon">Command<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/CommandPermissions.html" class="tsd-kind-icon">Command<wbr/>Permissions</a></li><li class="tsd-kind-class"><a href="classes/ContextMenuCommand.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/FunctionCommand.html" class="tsd-kind-icon">Function<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/GuildCommand.html" class="tsd-kind-icon">Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/HelpMessage.html" class="tsd-kind-icon">Help<wbr/>Message</a></li><li class="tsd-kind-class"><a href="classes/InputManager.html" class="tsd-kind-icon">Input<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/InputParameter.html" class="tsd-kind-icon">Input<wbr/>Parameter</a></li><li class="tsd-kind-class"><a href="classes/MissingParameterError.html" class="tsd-kind-icon">Missing<wbr/>Parameter<wbr/>Error</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ObjectID.html" class="tsd-kind-icon">ObjectID</a></li><li class="tsd-kind-class"><a href="classes/OperationSuccess.html" class="tsd-kind-icon">Operation<wbr/>Success</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Parameter.html" class="tsd-kind-icon">Parameter</a></li><li class="tsd-kind-class"><a href="classes/ParameterTypeError.html" class="tsd-kind-icon">Parameter<wbr/>Type<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PermissionCommand.html" class="tsd-kind-icon">Permission<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionGuildCommand.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionsError.html" class="tsd-kind-icon">Permissions<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PrefixManager.html" class="tsd-kind-icon">Prefix<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/SubCommandGroup.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group</a></li><li class="tsd-kind-class"><a href="classes/SystemMessageManager.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/TargetID.html" class="tsd-kind-icon">TargetID</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/APICommandInit.html" class="tsd-kind-icon">APICommand<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/APICommandObject.html" class="tsd-kind-icon">APICommand<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandInit.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandOptionObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/CommandPermission.html" class="tsd-kind-icon">Command<wbr/>Permission</a></li><li class="tsd-kind-interface"><a href="interfaces/CommandPermissionsInit.html" class="tsd-kind-icon">Command<wbr/>Permissions<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ContextMenuCommandInit.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ContextMenuCommandObject.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/FunctionCommandInit.html" class="tsd-kind-icon">Function<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/GuildCommandInit.html" class="tsd-kind-icon">Guild<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/HelpMessageParams.html" class="tsd-kind-icon">Help<wbr/>Message<wbr/>Params</a></li><li class="tsd-kind-interface"><a href="interfaces/InitOptions.html" class="tsd-kind-icon">Init<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/ParameterSchema.html" class="tsd-kind-icon">Parameter<wbr/>Schema</a></li><li class="tsd-kind-interface"><a href="interfaces/PermissionCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/PermissionGuildCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/RegisteredCommandObject.html" class="tsd-kind-icon">Registered<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/SubCommandGroupInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/SubCommandGroupObject.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/SubCommandInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/SystemMessageAppearance.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Appearance</a></li><li class="tsd-kind-interface"><a href="interfaces/SystemMessageData.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/TextCommandOptionChoiceObject.html" class="tsd-kind-icon">Text<wbr/>Command<wbr/>Option<wbr/>Choice<wbr/>Object</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#APICommandType" class="tsd-kind-icon">APICommand<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BaseCommandType" class="tsd-kind-icon">Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#BaseCommands" class="tsd-kind-icon">Base<wbr/>Commands</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ChatCommandOptionType" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ChildCommandInit" class="tsd-kind-icon">Child<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ChildCommandResolvable" class="tsd-kind-icon">Child<wbr/>Command<wbr/>Resolvable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ChildCommandType" class="tsd-kind-icon">Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ChildCommands" class="tsd-kind-icon">Child<wbr/>Commands</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandFunction" class="tsd-kind-icon">Command<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandFunctionReturnTypes" class="tsd-kind-icon">Command<wbr/>Function<wbr/>Return<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#CommandInit" class="tsd-kind-icon">Command<wbr/>Init</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandPermissionType" class="tsd-kind-icon">Command<wbr/>Permission<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandType" class="tsd-kind-icon">Command<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Commands" class="tsd-kind-icon">Commands</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ContextType" class="tsd-kind-icon">Context<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#InputParameterValue" class="tsd-kind-icon">Input<wbr/>Parameter<wbr/>Value</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MessageType" class="tsd-kind-icon">Message<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ObjectIdReturnType" class="tsd-kind-icon">Object<wbr/>Id<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ObjectIdType" class="tsd-kind-icon">Object<wbr/>Id<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ParameterResolvable" class="tsd-kind-icon">Parameter<wbr/>Resolvable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ParameterType" class="tsd-kind-icon">Parameter<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PermissionCheckTypes" class="tsd-kind-icon">Permission<wbr/>Check<wbr/>Types</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PermissionFunction" class="tsd-kind-icon">Permission<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ScopeResolvable" class="tsd-kind-icon">Scope<wbr/>Resolvable</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#TargetIdReturnType" class="tsd-kind-icon">Target<wbr/>Id<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TargetType" class="tsd-kind-icon">Target<wbr/>Type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="APICommandType" class="tsd-anchor"></a><h3>APICommand<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">APICommand<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CHAT_INPUT&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;MESSAGE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/api.ts#L8">src/structures/types/api.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Discord application command types
CHAT_INPUT - chat interaction (prefix or slash commands)
USER - context menu interaction for user
MESSAGE - context menu interaction for message</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="BaseCommandType" class="tsd-anchor"></a><h3>Base<wbr/>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Base<wbr/>Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;BASE&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;FUNCTION&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GUILD&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;PERMISSION&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;PERMISSIONGUILD&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L28">src/commands/types/commands.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Types of command bases</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="BaseCommands" class="tsd-anchor"></a><h3>Base<wbr/>Commands</h3><div class="tsd-signature tsd-kind-icon">Base<wbr/>Commands&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;BASE&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;FUNCTION&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;GUILD&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;PERMISSION&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;PERMISSIONGUILD&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L46">src/commands/types/commands.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Base command type selector</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChatCommandOptionType" class="tsd-anchor"></a><h3>Chat<wbr/>Command<wbr/>Option<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">5</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">6</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">7</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">8</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">9</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">10</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/api.ts#L93">src/structures/types/api.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Acceptable CHAT_INPUT command option types (read more <a href="https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type">here</a>)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ChildCommandInit" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Init</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Init&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;COMMAND&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;GROUP&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L96">src/commands/types/commands.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Child command initializer selector</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChildCommandResolvable" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <a href="classes/SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a><span class="tsd-signature-symbol"> | </span><a href="classes/SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L114">src/commands/types/commands.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Child command resolvables</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChildCommandType" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;COMMAND&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GROUP&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L40">src/commands/types/commands.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Child command types</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ChildCommands" class="tsd-anchor"></a><h3>Child<wbr/>Commands</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Commands&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;COMMAND&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;GROUP&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L68">src/commands/types/commands.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Child command type selector</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandFunction" class="tsd-anchor"></a><h3>Command<wbr/>Function</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L148">src/commands/types/commands.ts:148</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command function definition</p>
</div><div><p>If function returns (also after resolving a <em>Promise</em>):</p>
<ul>
<li><strong>void</strong> - If <em>announceSuccess</em> property is set to <em>true</em>, bot will automatically send a SUCCESS message (<a href="https://grz4na.github.io/commandbot-docs/classes/SystemMessageManager.html#SUCCESS">details</a>). If command has been called using slash commands and <em>announceSuccess</em> property is set to <em>false</em>, reply will be automatically deleted</li>
<li><strong>string</strong> - this string will be sent in a reply</li>
<li><strong><a href="https://discord.js.org/#/docs/main/stable/class/MessageEmbed">MessageEmbed</a></strong> - embedded content will be sent in a reply</li>
<li><strong><a href="https://discord.js.org/#/docs/main/stable/typedef/ReplyMessageOptions">ReplyMessageOptions</a></strong> - these options will get used to send a reply</li>
</ul>
<p>It is possible to manually send replies directly from the command function using the interaction property from <a href="classes/InputManager.html">InputManager</a> argument. If you are using slash commands don&#39;t forget to use the <em><a href="https://discord.js.org/#/docs/main/stable/class/CommandInteraction?scrollTo=editReply">CommandInteraction.prototype.editReply</a></em> method instead of the <em>reply</em> method since a <strong>reply is already deferred</strong> when a command function gets called (read more <a href="https://discord.com/developers/docs/interactions/receiving-and-responding">here</a>) If you try to create a new reply, you app will throw an error that will result a crash.</p>
<p>If you manually reply to a slash command interaction and return <em>void</em> from the command function, a SUCCESS message will not be sent or reply will not get deleted (if you want to disable SUCCESS messages on prefix interactions set <em>announceSuccess</em> property to <em>false</em>).</p>
<p>If command function throws an error, it will automatically get caught and your bot will send an ERROR message. The app <strong>will not</strong> crash.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandFunctionReturnTypes" class="tsd-anchor"></a><h3>Command<wbr/>Function<wbr/>Return<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Function<wbr/>Return<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L130">src/commands/types/commands.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>All types that can be returned from a command function</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="CommandInit" class="tsd-anchor"></a><h3>Command<wbr/>Init</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Init&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;CHAT&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;CONTEXT&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L90">src/commands/types/commands.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command initializer selector</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandPermissionType" class="tsd-anchor"></a><h3>Command<wbr/>Permission<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Permission<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ROLE&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/api.ts#L147">src/structures/types/api.ts:147</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Discord permission types</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandType" class="tsd-anchor"></a><h3>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CHAT&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;CONTEXT&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L34">src/commands/types/commands.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command types</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="Commands" class="tsd-anchor"></a><h3>Commands</h3><div class="tsd-signature tsd-kind-icon">Commands&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;CHAT&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;CONTEXT&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L62">src/commands/types/commands.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command type selector</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ContextType" class="tsd-anchor"></a><h3>Context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Context<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;MESSAGE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/commands.ts#L124">src/commands/types/commands.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Context menu command types</p>
</div><div><ul>
<li>USER - right-click context menu interactions on users</li>
<li>MESSAGE - right-click context menu interactions on messages</li>
</ul>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="InputParameterValue" class="tsd-anchor"></a><h3>Input<wbr/>Parameter<wbr/>Value</h3><div class="tsd-signature tsd-kind-icon">Input<wbr/>Parameter<wbr/>Value&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;string&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;boolean&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;number&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;user&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;user&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;role&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;role&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;mentionable&quot;</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;mentionable&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/Parameter.ts#L17">src/structures/types/Parameter.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Input parameter value resolvable selector</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="MessageType" class="tsd-anchor"></a><h3>Message<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Message<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PERMISSION&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ERROR&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;NOT_FOUND&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;SUCCESS&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L9">src/structures/types/SystemMessage.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Types of system messages</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ObjectIdReturnType" class="tsd-anchor"></a><h3>Object<wbr/>Id<wbr/>Return<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Object<wbr/>Id<wbr/>Return<wbr/>Type&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">TextChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">VoiceChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CategoryChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NewsChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StageChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StoreChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;user&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;role&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Role</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;mentionable&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">TextChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">VoiceChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CategoryChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NewsChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StageChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StoreChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Role</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/Parameter.ts#L90">src/structures/types/Parameter.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p><em>ObjectID.prototype.toObject()</em> return type selector</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ObjectIdType" class="tsd-anchor"></a><h3>Object<wbr/>Id<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Object<wbr/>Id<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;user&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;role&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;mentionable&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/Parameter.ts#L84">src/structures/types/Parameter.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Types of Discord objects (IDs contained in an <a href="classes/ObjectID.html">ObjectID</a> wrapper)</p>
<ul>
<li><strong>user</strong> - server users list shown as selection menu in Discord</li>
<li><strong>role</strong> - server roles list shown as selection menu in Discord</li>
<li><strong>channel</strong> - server text, voice, stage, and category channels list shown as selection menu in Discord</li>
<li><strong>mentionable</strong> - all objects that can be mentioned list shown as selection menu in Discord</li>
</ul>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ParameterResolvable" class="tsd-anchor"></a><h3>Parameter<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Parameter<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="classes/TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/Parameter.ts#L37">src/structures/types/Parameter.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>All parameter resolvables</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ParameterType" class="tsd-anchor"></a><h3>Parameter<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Parameter<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;string&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;boolean&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;number&quot;</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/Parameter.ts#L11">src/structures/types/Parameter.ts:11</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameter type values</p>
<ul>
<li><strong>string</strong> - text value</li>
<li><strong>boolean</strong> - True or False</li>
<li><strong>number</strong> - number (double) value</li>
</ul>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="PermissionCheckTypes" class="tsd-anchor"></a><h3>Permission<wbr/>Check<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Permission<wbr/>Check<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ALL&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ANY&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/permissions.ts#L11">src/commands/types/permissions.ts:11</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Permission checking methods</p>
</div><div><p>ALL - uses <a href="https://discord.js.org/#/docs/main/stable/class/Permissions?scrollTo=has"><em>Permissions.prototype.has</em></a> method</p>
<p>ANY - uses <a href="https://discord.js.org/#/docs/main/stable/class/Permissions?scrollTo=any"><em>Permissions.prototype.any</em></a> method</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="PermissionFunction" class="tsd-anchor"></a><h3>Permission<wbr/>Function</h3><div class="tsd-signature tsd-kind-icon">Permission<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/commands/types/permissions.ts#L17">src/commands/types/permissions.ts:17</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</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"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Definition of permission function</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ScopeResolvable" class="tsd-anchor"></a><h3>Scope<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Scope<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/PrefixManager.ts#L7">src/structures/types/PrefixManager.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Prefix scope types</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="TargetIdReturnType" class="tsd-anchor"></a><h3>Target<wbr/>Id<wbr/>Return<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Target<wbr/>Id<wbr/>Return<wbr/>Type&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">&quot;MESSAGE&quot;</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/Parameter.ts#L110">src/structures/types/Parameter.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p><em>TargetID.prototype.toObject()</em> return type selector*</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#TargetType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="TargetType" class="tsd-anchor"></a><h3>Target<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Target<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;MESSAGE&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/Parameter.ts#L104">src/structures/types/Parameter.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Types of Discord context menu targets (IDs contained in a <a href="classes/TargetID.html">TargetID</a> wrapper)</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/Bot.html" class="tsd-kind-icon">Bot</a></li><li class="tsd-kind-class"><a href="classes/ChatCommand.html" class="tsd-kind-icon">Chat<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-class"><a href="classes/CommandManager.html" class="tsd-kind-icon">Command<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/CommandPermissions.html" class="tsd-kind-icon">Command<wbr/>Permissions</a></li><li class="tsd-kind-class"><a href="classes/ContextMenuCommand.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/FunctionCommand.html" class="tsd-kind-icon">Function<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/GuildCommand.html" class="tsd-kind-icon">Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/HelpMessage.html" class="tsd-kind-icon">Help<wbr/>Message</a></li><li class="tsd-kind-class"><a href="classes/InputManager.html" class="tsd-kind-icon">Input<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/InputParameter.html" class="tsd-kind-icon">Input<wbr/>Parameter</a></li><li class="tsd-kind-class"><a href="classes/MissingParameterError.html" class="tsd-kind-icon">Missing<wbr/>Parameter<wbr/>Error</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ObjectID.html" class="tsd-kind-icon">ObjectID</a></li><li class="tsd-kind-class"><a href="classes/OperationSuccess.html" class="tsd-kind-icon">Operation<wbr/>Success</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Parameter.html" class="tsd-kind-icon">Parameter</a></li><li class="tsd-kind-class"><a href="classes/ParameterTypeError.html" class="tsd-kind-icon">Parameter<wbr/>Type<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PermissionCommand.html" class="tsd-kind-icon">Permission<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionGuildCommand.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionsError.html" class="tsd-kind-icon">Permissions<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PrefixManager.html" class="tsd-kind-icon">Prefix<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/SubCommandGroup.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group</a></li><li class="tsd-kind-class"><a href="classes/SystemMessageManager.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/TargetID.html" class="tsd-kind-icon">TargetID</a></li><li class="tsd-kind-interface"><a href="interfaces/APICommandInit.html" class="tsd-kind-icon">APICommand<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/APICommandObject.html" class="tsd-kind-icon">APICommand<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandInit.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandOptionObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/CommandPermission.html" class="tsd-kind-icon">Command<wbr/>Permission</a></li><li class="tsd-kind-interface"><a href="interfaces/CommandPermissionsInit.html" class="tsd-kind-icon">Command<wbr/>Permissions<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ContextMenuCommandInit.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ContextMenuCommandObject.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/FunctionCommandInit.html" class="tsd-kind-icon">Function<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/GuildCommandInit.html" class="tsd-kind-icon">Guild<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/HelpMessageParams.html" class="tsd-kind-icon">Help<wbr/>Message<wbr/>Params</a></li><li class="tsd-kind-interface"><a href="interfaces/InitOptions.html" class="tsd-kind-icon">Init<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/ParameterSchema.html" class="tsd-kind-icon">Parameter<wbr/>Schema</a></li><li class="tsd-kind-interface"><a href="interfaces/PermissionCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/PermissionGuildCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/RegisteredCommandObject.html" class="tsd-kind-icon">Registered<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/SubCommandGroupInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/SubCommandGroupObject.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/SubCommandInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/SystemMessageAppearance.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Appearance</a></li><li class="tsd-kind-interface"><a href="interfaces/SystemMessageData.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/TextCommandOptionChoiceObject.html" class="tsd-kind-icon">Text<wbr/>Command<wbr/>Option<wbr/>Choice<wbr/>Object</a></li><li class="tsd-kind-type-alias"><a href="modules.html#APICommandType" class="tsd-kind-icon">APICommand<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BaseCommandType" class="tsd-kind-icon">Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#BaseCommands" class="tsd-kind-icon">Base<wbr/>Commands</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ChatCommandOptionType" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ChildCommandInit" class="tsd-kind-icon">Child<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ChildCommandResolvable" class="tsd-kind-icon">Child<wbr/>Command<wbr/>Resolvable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ChildCommandType" class="tsd-kind-icon">Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ChildCommands" class="tsd-kind-icon">Child<wbr/>Commands</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandFunction" class="tsd-kind-icon">Command<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandFunctionReturnTypes" class="tsd-kind-icon">Command<wbr/>Function<wbr/>Return<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#CommandInit" class="tsd-kind-icon">Command<wbr/>Init</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandPermissionType" class="tsd-kind-icon">Command<wbr/>Permission<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CommandType" class="tsd-kind-icon">Command<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Commands" class="tsd-kind-icon">Commands</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ContextType" class="tsd-kind-icon">Context<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#InputParameterValue" class="tsd-kind-icon">Input<wbr/>Parameter<wbr/>Value</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MessageType" class="tsd-kind-icon">Message<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ObjectIdReturnType" class="tsd-kind-icon">Object<wbr/>Id<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ObjectIdType" class="tsd-kind-icon">Object<wbr/>Id<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ParameterResolvable" class="tsd-kind-icon">Parameter<wbr/>Resolvable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ParameterType" class="tsd-kind-icon">Parameter<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PermissionCheckTypes" class="tsd-kind-icon">Permission<wbr/>Check<wbr/>Types</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PermissionFunction" class="tsd-kind-icon">Permission<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ScopeResolvable" class="tsd-kind-icon">Scope<wbr/>Resolvable</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#TargetIdReturnType" class="tsd-kind-icon">Target<wbr/>Id<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TargetType" class="tsd-kind-icon">Target<wbr/>Type</a></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>