Archived
added documentation
This commit is contained in:
mmacierzanka committed
1 parent
aa6cb8b3da
commit
cea34d12f1
60 files changed
+4042
-2
No files matched your search
+1
-2
@@ -1,4 +1,3 @@
|
||||
node_modules
|
||||
test
|
||||
dist
|
||||
docs
|
||||
dist
|
||||
@@ -0,0 +1 @@
|
||||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||
@@ -0,0 +1,99 @@
|
||||
:root {
|
||||
--light-hl-0: #008000;
|
||||
--dark-hl-0: #6A9955;
|
||||
--light-hl-1: #001080;
|
||||
--dark-hl-1: #9CDCFE;
|
||||
--light-hl-2: #000000;
|
||||
--dark-hl-2: #D4D4D4;
|
||||
--light-hl-3: #0000FF;
|
||||
--dark-hl-3: #569CD6;
|
||||
--light-hl-4: #0070C1;
|
||||
--dark-hl-4: #4FC1FF;
|
||||
--light-hl-5: #795E26;
|
||||
--dark-hl-5: #DCDCAA;
|
||||
--light-hl-6: #A31515;
|
||||
--dark-hl-6: #CE9178;
|
||||
--light-hl-7: #AF00DB;
|
||||
--dark-hl-7: #C586C0;
|
||||
--light-hl-8: #000000FF;
|
||||
--dark-hl-8: #D4D4D4;
|
||||
--light-hl-9: #000000;
|
||||
--dark-hl-9: #C8C8C8;
|
||||
--light-hl-10: #267F99;
|
||||
--dark-hl-10: #4EC9B0;
|
||||
--light-code-background: #FFFFFF;
|
||||
--dark-code-background: #1E1E1E;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) { :root {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--hl-8: var(--light-hl-8);
|
||||
--hl-9: var(--light-hl-9);
|
||||
--hl-10: var(--light-hl-10);
|
||||
--code-background: var(--light-code-background);
|
||||
} }
|
||||
|
||||
@media (prefers-color-scheme: dark) { :root {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--hl-8: var(--dark-hl-8);
|
||||
--hl-9: var(--dark-hl-9);
|
||||
--hl-10: var(--dark-hl-10);
|
||||
--code-background: var(--dark-code-background);
|
||||
} }
|
||||
|
||||
body.light {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--hl-8: var(--light-hl-8);
|
||||
--hl-9: var(--light-hl-9);
|
||||
--hl-10: var(--light-hl-10);
|
||||
--code-background: var(--light-code-background);
|
||||
}
|
||||
|
||||
body.dark {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--hl-8: var(--dark-hl-8);
|
||||
--hl-9: var(--dark-hl-9);
|
||||
--hl-10: var(--dark-hl-10);
|
||||
--code-background: var(--dark-code-background);
|
||||
}
|
||||
|
||||
.hl-0 { color: var(--hl-0); }
|
||||
.hl-1 { color: var(--hl-1); }
|
||||
.hl-2 { color: var(--hl-2); }
|
||||
.hl-3 { color: var(--hl-3); }
|
||||
.hl-4 { color: var(--hl-4); }
|
||||
.hl-5 { color: var(--hl-5); }
|
||||
.hl-6 { color: var(--hl-6); }
|
||||
.hl-7 { color: var(--hl-7); }
|
||||
.hl-8 { color: var(--hl-8); }
|
||||
.hl-9 { color: var(--hl-9); }
|
||||
.hl-10 { color: var(--hl-10); }
|
||||
pre, code { background: var(--code-background); }
|
||||
File diff suppressed because it is too large.
Load diff
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
@@ -0,0 +1,52 @@
|
||||
(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var $e=typeof require!="undefined"?require:t=>{throw new Error('Dynamic require of "'+t+'" is not supported')};var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of Oe(e))!_e.call(t,n)&&n!=="default"&&J(t,n,{get:()=>e[n],enumerable:!(r=Pe(e,n))||r.enumerable});return t},Ae=t=>De(Me(J(t!=null?Ce(Re(t)):{},"default",t&&t.__esModule&&"default"in t?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ue,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i<n.length;i++){var s=n[i],o=e[s];if(Array.isArray(o)){r[s]=o.slice();continue}if(typeof o=="string"||typeof o=="number"||typeof o=="boolean"){r[s]=o;continue}throw new TypeError("clone is not deep and does not support nested objects")}return r},t.FieldRef=function(e,r,n){this.docRef=e,this.fieldName=r,this._stringValue=n},t.FieldRef.joiner="/",t.FieldRef.fromString=function(e){var r=e.indexOf(t.FieldRef.joiner);if(r===-1)throw"malformed field ref string";var n=e.slice(0,r),i=e.slice(r+1);return new t.FieldRef(i,n,e)},t.FieldRef.prototype.toString=function(){return this._stringValue==null&&(this._stringValue=this.fieldName+t.FieldRef.joiner+this.docRef),this._stringValue};t.Set=function(e){if(this.elements=Object.create(null),e){this.length=e.length;for(var r=0;r<this.length;r++)this.elements[e[r]]=!0}else this.length=0},t.Set.complete={intersect:function(e){return e},union:function(){return this},contains:function(){return!0}},t.Set.empty={intersect:function(){return this},union:function(e){return e},contains:function(){return!1}},t.Set.prototype.contains=function(e){return!!this.elements[e]},t.Set.prototype.intersect=function(e){var r,n,i,s=[];if(e===t.Set.complete)return this;if(e===t.Set.empty)return e;this.length<e.length?(r=this,n=e):(r=e,n=this),i=Object.keys(r.elements);for(var o=0;o<i.length;o++){var a=i[o];a in n.elements&&s.push(a)}return new t.Set(s)},t.Set.prototype.union=function(e){return e===t.Set.complete?t.Set.complete:e===t.Set.empty?this:new t.Set(Object.keys(this.elements).concat(Object.keys(e.elements)))},t.idf=function(e,r){var n=0;for(var i in e)i!="_index"&&(n+=Object.keys(e[i]).length);var s=(r-n+.5)/(n+.5);return Math.log(1+Math.abs(s))},t.Token=function(e,r){this.str=e||"",this.metadata=r||{}},t.Token.prototype.toString=function(){return this.str},t.Token.prototype.update=function(e){return this.str=e(this.str,this.metadata),this},t.Token.prototype.clone=function(e){return e=e||function(r){return r},new t.Token(e(this.str,this.metadata),this.metadata)};t.tokenizer=function(e,r){if(e==null||e==null)return[];if(Array.isArray(e))return e.map(function(f){return new t.Token(t.utils.asString(f).toLowerCase(),t.utils.clone(r))});for(var n=e.toString().toLowerCase(),i=n.length,s=[],o=0,a=0;o<=i;o++){var c=n.charAt(o),l=o-a;if(c.match(t.tokenizer.separator)||o==i){if(l>0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index.
|
||||
`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n<r;n++){for(var i=this._stack[n],s=[],o=0;o<e.length;o++){var a=i(e[o],o,e);if(!(a==null||a===""))if(Array.isArray(a))for(var c=0;c<a.length;c++)s.push(a[c]);else s.push(a)}e=s}return e},t.Pipeline.prototype.runString=function(e,r){var n=new t.Token(e,r);return this.run([n]).map(function(i){return i.toString()})},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})};t.Vector=function(e){this._magnitude=0,this.elements=e||[]},t.Vector.prototype.positionForIndex=function(e){if(this.elements.length==0)return 0;for(var r=0,n=this.elements.length/2,i=n-r,s=Math.floor(i/2),o=this.elements[s*2];i>1&&(o<e&&(r=s),o>e&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(o<e)return(s+1)*2},t.Vector.prototype.insert=function(e,r){this.upsert(e,r,function(){throw"duplicate index"})},t.Vector.prototype.upsert=function(e,r,n){this._magnitude=0;var i=this.positionForIndex(e);this.elements[i]==e?this.elements[i+1]=n(this.elements[i+1],r):this.elements.splice(i,0,e,r)},t.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var e=0,r=this.elements.length,n=1;n<r;n+=2){var i=this.elements[n];e+=i*i}return this._magnitude=Math.sqrt(e)},t.Vector.prototype.dot=function(e){for(var r=0,n=this.elements,i=e.elements,s=n.length,o=i.length,a=0,c=0,l=0,h=0;l<s&&h<o;)a=n[l],c=i[h],a<c?l+=2:a>c?h+=2:a==c&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r<this.elements.length;r+=2,n++)e[n]=this.elements[r];return e},t.Vector.prototype.toJSON=function(){return this.elements};t.stemmer=function(){var e={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},r={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},n="[^aeiou]",i="[aeiouy]",s=n+"[^aeiouy]*",o=i+"[aeiou]*",a="^("+s+")?"+o+s,c="^("+s+")?"+o+s+"("+o+")?$",l="^("+s+")?"+o+s+o+s,h="^("+s+")?"+i,f=new RegExp(a),v=new RegExp(l),b=new RegExp(c),y=new RegExp(h),E=/^(.+?)(ss|i)es$/,p=/^(.+?)([^s])s$/,m=/^(.+?)eed$/,T=/^(.+?)(ed|ing)$/,w=/.$/,k=/(at|bl|iz)$/,M=new RegExp("([^aeiouylsz])\\1$"),j=new RegExp("^"+s+i+"[^aeiouwxy]$"),V=/^(.+?[^aeiou])y$/,B=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,q=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,H=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,$=/^(.+?)(s|t)(ion)$/,P=/^(.+?)e$/,W=/ll$/,U=new RegExp("^"+s+i+"[^aeiouwxy]$"),z=function(u){var g,O,S,d,x,R,D;if(u.length<3)return u;if(S=u.substr(0,1),S=="y"&&(u=S.toUpperCase()+u.substr(1)),d=E,x=p,d.test(u)?u=u.replace(d,"$1$2"):x.test(u)&&(u=u.replace(x,"$1$2")),d=m,x=T,d.test(u)){var L=d.exec(u);d=f,d.test(L[1])&&(d=w,u=u.replace(d,""))}else if(x.test(u)){var L=x.exec(u);g=L[1],x=y,x.test(g)&&(u=g,x=k,R=M,D=j,x.test(u)?u=u+"e":R.test(u)?(d=w,u=u.replace(d,"")):D.test(u)&&(u=u+"e"))}if(d=V,d.test(u)){var L=d.exec(u);g=L[1],u=g+"i"}if(d=B,d.test(u)){var L=d.exec(u);g=L[1],O=L[2],d=f,d.test(g)&&(u=g+e[O])}if(d=q,d.test(u)){var L=d.exec(u);g=L[1],O=L[2],d=f,d.test(g)&&(u=g+r[O])}if(d=H,x=$,d.test(u)){var L=d.exec(u);g=L[1],d=v,d.test(g)&&(u=g)}else if(x.test(u)){var L=x.exec(u);g=L[1]+L[2],x=v,x.test(g)&&(u=g)}if(d=P,d.test(u)){var L=d.exec(u);g=L[1],d=v,x=b,R=U,(d.test(g)||x.test(g)&&!R.test(g))&&(u=g)}return d=W,x=v,d.test(u)&&x.test(u)&&(d=w,u=u.replace(d,"")),S=="y"&&(u=S.toLowerCase()+u.substr(1)),u};return function(F){return F.update(z)}}(),t.Pipeline.registerFunction(t.stemmer,"stemmer");t.generateStopWordFilter=function(e){var r=e.reduce(function(n,i){return n[i]=i,n},{});re
Line truncated
|
||||
/*!
|
||||
* lunr.Builder
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.Index
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.Pipeline
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.Set
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.TokenSet
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.Vector
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.stemmer
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
* Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
|
||||
*/
|
||||
/*!
|
||||
* lunr.stopWordFilter
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.tokenizer
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.trimmer
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/*!
|
||||
* lunr.utils
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
*/
|
||||
/**
|
||||
* lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
|
||||
* Copyright (C) 2020 Oliver Nightingale
|
||||
* @license MIT
|
||||
*/
|
||||
@@ -0,0 +1 @@
|
||||
window.searchData = {"kinds":{"128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","4194304":"Type alias","8388608":"Event"},"rows":[{"id":0,"kind":128,"name":"Bot","url":"classes/Bot.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/Bot.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Bot"},{"id":2,"kind":8388608,"name":"on","url":"classes/Bot.html#on","classes":"tsd-kind-event tsd-parent-kind-class","parent":"Bot"},{"id":3,"kind":1024,"name":"name","url":"classes/Bot.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":4,"kind":1024,"name":"client","url":"classes/Bot.html#client","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":5,"kind":1024,"name":"commands","url":"classes/Bot.html#commands","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":6,"kind":1024,"name":"token","url":"classes/Bot.html#token","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":7,"kind":1024,"name":"applicationId","url":"classes/Bot.html#applicationId","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":8,"kind":1024,"name":"messages","url":"classes/Bot.html#messages","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":9,"kind":65536,"name":"__type","url":"classes/Bot.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Bot"},{"id":10,"kind":1024,"name":"help","url":"classes/Bot.html#__type.help","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Bot.__type"},{"id":11,"kind":1024,"name":"system","url":"classes/Bot.html#__type.system","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Bot.__type"},{"id":12,"kind":2048,"name":"start","url":"classes/Bot.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Bot"},{"id":13,"kind":256,"name":"InitOptions","url":"interfaces/InitOptions.html","classes":"tsd-kind-interface"},{"id":14,"kind":1024,"name":"name","url":"interfaces/InitOptions.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":15,"kind":1024,"name":"globalPrefix","url":"interfaces/InitOptions.html#globalPrefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":16,"kind":1024,"name":"argumentSeparator","url":"interfaces/InitOptions.html#argumentSeparator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":17,"kind":1024,"name":"commandSeparator","url":"interfaces/InitOptions.html#commandSeparator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":18,"kind":1024,"name":"clientOptions","url":"interfaces/InitOptions.html#clientOptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":19,"kind":1024,"name":"token","url":"interfaces/InitOptions.html#token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":20,"kind":1024,"name":"applicationId","url":"interfaces/InitOptions.html#applicationId","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":21,"kind":256,"name":"ChatCommandInit","url":"interfaces/ChatCommandInit.html","classes":"tsd-kind-interface"},{"id":22,"kind":1024,"name":"parameters","url":"interfaces/ChatCommandInit.html#parameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":23,"kind":1024,"name":"aliases","url":"interfaces/ChatCommandInit.html#aliases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":24,"kind":1024,"name":"description","url":"interfaces/ChatCommandInit.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":25,"kind":1024,"name":"usage","url":"interfaces/ChatCommandInit.html#usage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":26,"kind":1024,"name":"visible","url":"interfaces/ChatCommandInit.html#visible","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":27,"kind":1024,"name":"slash","url":"interfaces/ChatCommandInit.html#slash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":28,"kind":1024,"name":"dm","url":"interfaces/ChatCommandInit.html#dm","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":29,"kind":1024,"name":"guilds","url":"interfaces/ChatCommandInit.html#guilds","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":30,"kind":1024,"name":"permissions","url":"interfaces/ChatCommandInit.html#permissions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":Line truncated
|
||||
File diff suppressed because it is too large.
Load diff
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
@@ -0,0 +1,44 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Bot | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="Bot.html">Bot</a></li></ul><h1>Class Bot</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Application instance</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">EventEmitter</span><ul class="tsd-hierarchy"><li><span class="target">Bot</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Bot.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Events</h3><ul class="tsd-index-list"><li class="tsd-kind-event tsd-parent-kind-class"><a href="Bot.html#on" class="tsd-kind-icon">on</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#commands" class="tsd-kind-icon">commands</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#messages" class="tsd-kind-icon">messages</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#token" class="tsd-kind-icon">token</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</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-class tsd-is-external"><a href="Bot.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Bot.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#getEventListener" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="BoLine truncated
|
||||
<p>Main bot constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <a href="../interfaces/InitOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">InitOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Events</h2><section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"><a name="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-event tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"READY"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"MESSAGE"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>m<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"COMMAND"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ERROR"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L17">src/structures/Bot.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted after connecting to Discord API</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"READY"</span></h5></li><li><h5>listener: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L22">src/structures/Bot.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted whenever bot receives a Discord message</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"MESSAGE"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>m<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">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>m<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">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>m: <span class="tsd-signature-type">Message</span></h5></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 <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L27">src/structures/Bot.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted whenever bots receives a Discord message or interaction that gets recognized as a CommandBot command</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"COMMAND"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>m: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span></h5></li><li><h5>cmdMsg: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5></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 <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L32">src/structures/Bot.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted on every bot error</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ERROR"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>e<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></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>e<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"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>e: <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></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li></ul></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-class"><a name="applicationId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> application<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">application<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L79">src/structures/Bot.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API application ID</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="client" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> client</h3><div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L55">src/structures/Bot.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord.js {@link Client} instance</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="commands" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> commands</h3><div class="tsd-signature tsd-kind-icon">commands<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L63">src/structures/Bot.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Instance command manager</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="messages" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> messages</h3><div class="tsd-signature tsd-kind-icon">messages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>help<span class="tsd-signature-symbol">: </span><a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a><span class="tsd-signature-symbol">; </span>system<span class="tsd-signature-symbol">: </span><a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L87">src/structures/Bot.ts:87</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Messages and embeds configuration</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>help<span class="tsd-signature-symbol">: </span><a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Help message configuration</p>
|
||||
</div></div></li><li class="tsd-parameter"><h5>system<span class="tsd-signature-symbol">: </span><a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="SystemMessageManager.html">SystemMessageManager</a> storing messages' configuration</p>
|
||||
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L47">src/structures/Bot.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Bot name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="token" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> token</h3><div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/Bot.ts#L71">src/structures/Bot.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord Bot token</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="captureRejectionSymbol" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> capture<wbr/>Rejection<wbr/>Symbol</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Bot.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:46</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="captureRejections" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Rejections</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:52</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Sets or gets the default captureRejection value for all emitters.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="defaultMaxListeners" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> default<wbr/>Max<wbr/>Listeners</h3><div class="tsd-signature tsd-kind-icon">default<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:53</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="errorMonitor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error<wbr/>Monitor</h3><div class="tsd-signature tsd-kind-icon">error<wbr/>Monitor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Bot.html#errorMonitor" class="tsd-signature-type" data-tsd-kind="Property">errorMonitor</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:45</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>This symbol shall be used to install a listener for only monitoring <code>'error'</code>
|
||||
events. Listeners installed using this symbol are called before the regular
|
||||
<code>'error'</code> listeners are called.</p>
|
||||
</div><div><p>Installing a listener using this symbol does not change the behavior once an
|
||||
<code>'error'</code> event is emitted, therefore the process will still crash if no
|
||||
regular <code>'error'</code> listener is installed.</p>
|
||||
</div></div></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-class tsd-is-external"><a name="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:72</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-symbol"> => </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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-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><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></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 <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a name="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, <span class="tsd-signature-symbol">...</span>args<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-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 node_modules/@types/node/events.d.ts:82</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><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-class tsd-is-external"><a name="eventNames" class="tsd-anchor"></a><h3>event<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">event<wbr/>Names<span class="tsd-signature-symbol">(</span>Line truncated
|
||||
<p>Starts your Discord bot</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> port: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> register: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><div><p>whether this operation has been completed successfully</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="getEventListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Event<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Event<wbr/>Listener<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMEventTarget</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventEmitter</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:34</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns a list listener for a specific emitter event name.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">DOMEventTarget</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventEmitter</span></h5></li><li><h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="listenerCount-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:30</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>since v4.0.0</p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5></li><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="on-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:27</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5></li><li><h5>event: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="once-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeEventTarget</span>, event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><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></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMEventTarget</span>, event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:25</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">NodeEventTarget</span></h5></li><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><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></h4></li>Line truncated
|
||||
@@ -0,0 +1,80 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommand | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ChatCommand.html">ChatCommand</a></li></ul><h1>Class ChatCommand</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A representation of CHAT_INPUT command (also known as a slash command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommand</span><ul class="tsd-hierarchy"><li><a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</a></li></ul></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ChatCommand.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#visible" class="tsd-kind-icon">visible</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#hasSubCommands" class="tsd-kind-icon">has<wbr/>Sub<wbr/>Commands</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-class tsd-has-type-parameter"><a href="ChatCommand.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#fetchSubcommand" class="tsd-kind-icon">fetch<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#getSubcommand" class="tsd-kind-icon">get<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="cLine truncated
|
||||
<p>ChatCommand constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>a manager that this command belongs to</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="../interfaces/ChatCommandInit.html">ChatCommandInit</a> object containing all options needed to create a <a href="ChatCommand.html">ChatCommand</a></p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></h4></li></ul></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-class tsd-is-private"><a name="_children" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _children</h3><div class="tsd-signature tsd-kind-icon">_children<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L26">src/commands/ChatCommand.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Subcommands and groups of this command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> aliases</h3><div class="tsd-signature tsd-kind-icon">aliases<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L41">src/commands/ChatCommand.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of different names that can be used to invoke a command (when using prefix interactions)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L49">src/commands/ChatCommand.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description displayed in the help message or in slash commands menu (Default description: "No description")</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L33">src/commands/ChatCommand.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of parameters that can passed to this command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> slash</h3><div class="tsd-signature tsd-kind-icon">slash<span class="tsd-signature-symbol">:</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/aa6cb8b/src/commands/ChatCommand.ts#L73">src/commands/ChatCommand.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be registered as a slash command (default: true)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> usage</h3><div class="tsd-signature tsd-kind-icon">usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L57">src/commands/ChatCommand.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage displayed in the help message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> visible</h3><div class="tsd-signature tsd-kind-icon">visible<span class="tsd-signature-symbol">:</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/aa6cb8b/src/commands/ChatCommand.ts#L65">src/commands/ChatCommand.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command is visible in the help message (default: true)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L141">src/commands/ChatCommand.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns list of attached subcommands</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="hasSubCommands" class="tsd-anchor"></a><h3>has<wbr/>Sub<wbr/>Commands</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasSubCommands<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 <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L132">src/commands/ChatCommand.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns <em>true</em> if the command has subcommands attached</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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-class tsd-has-type-parameter"><a name="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">append<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L166">src/commands/ChatCommand.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Attaches subcommand or subcommand group to this ChatCommand (this makes the base command usable only via prefix interactions)</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand type</p>
|
||||
</div></div></li><li><h5>options: <a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A computed subcommand object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="fetchSubcommand" class="tsd-anchor"></a><h3>fetch<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L191">src/commands/ChatCommand.ts:191</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter options</p>
|
||||
</div></div></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h4><div><p>an <a href="InputManager.html">InputManager</a> containing all interaction-related data or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getSubcommand" class="tsd-anchor"></a><h3>get<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, group<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-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L250">src/commands/ChatCommand.ts:250</a></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><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand name</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> group: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></h4><div><p>a <a href="SubCommand.html">SubCommand</a> object or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L152">src/commands/ChatCommand.ts:152</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data manager</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L269">src/commands/ChatCommand.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts <a href="ChatCommand.html">ChatCommand</a> instance to object that is recognized by the Discord API</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></h4><div><p>Discord API object</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ChatCommand.html" class="tsd-kind-icon">Chat<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ChatCommand.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#visible" class="tsd-kind-icon">visible</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#hasSubCommands" class="tsd-kind-icon">has<wbr/>Sub<wbr/>Commands</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="ChatCommand.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#fetchSubcommand" class="tsd-kind-icon">fetch<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#getSubcommand" class="tsd-kind-icon">get<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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-parentLine truncated
|
||||
@@ -0,0 +1,37 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Command | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="Command.html">Command</a></li></ul><h1>Class Command</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Bot core command object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Command</span><ul class="tsd-hierarchy"><li><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></li><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Command.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#type" class="tsd-kind-icon">type</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-class tsd-has-type-parameter"><a href="Command.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Command.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L56">src/commands/base/Command.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command core constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>manager bound to this command</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command internal type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h4></li></ul></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-class"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</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/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-has-type-parameter"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="Command.html" class="tsd-kind-icon">Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Command.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Command.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,92 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandManager | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="CommandManager.html">CommandManager</a></li></ul><h1>Class CommandManager</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object that stores the registered commands and is responsible for data exchanging with the Discord API</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandManager</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CommandManager.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_commands" class="tsd-kind-icon">_commands</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_globalEntryName" class="tsd-kind-icon">_global<wbr/>Entry<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_registerCache" class="tsd-kind-icon">_register<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#helpCmd" class="tsd-kind-icon">help<wbr/>Cmd</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#prefix" class="tsd-kind-icon">prefix</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#baseApiUrl" class="tsd-kind-icon">base<wbr/>Api<wbr/>Url</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#cache" class="tsd-kind-icon">cache</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#commandsCount" class="tsd-kind-icon">commands<wbr/>Count</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-class tsd-has-type-parameter"><a href="CommandManager.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#arrayToMap" class="tsd-kind-icon">array<wbr/>To<wbr/>Map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="CommandManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getApi" class="tsd-kind-icon">get<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#getCache" class="tsd-kind-icon">get<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getIdApi" class="tsd-kind-icon">get<wbr/>Id<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getPermissionsApi" class="tsd-kind-icon">get<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#listApi" class="tsd-kind-icon">list<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#register" class="tsd-kind-icon">register</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#setPermissionsApi" class="tsd-kind-icon">set<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#updateCache" class="tsd-kind-icon">update<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#isCommand" class="tsd-kind-icon">is<wbr/>Command</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Command<wbr/>Manager<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a>, helpMsg<spanLine truncated
|
||||
<p>client that this manager belongs to</p>
|
||||
</div></div></li><li><h5>helpMsg: <a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameters defining appearance of the help message</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> argSep: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cmdSep: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h4></li></ul></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-class tsd-is-private"><a name="_commands" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _commands</h3><div class="tsd-signature tsd-kind-icon">_commands<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L31">src/structures/CommandManager.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of commands registered in the manager</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="_globalEntryName" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _global<wbr/>Entry<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">_global<wbr/>Entry<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "global"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L39">src/structures/CommandManager.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="_registerCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _register<wbr/>Cache</h3><div class="tsd-signature tsd-kind-icon">_register<wbr/>Cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</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">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L38">src/structures/CommandManager.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Cache of Discord API commands data</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="argumentSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> argument<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">argument<wbr/>Separator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L71">src/structures/CommandManager.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A string used to split all incoming input data from Discord messages</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="client" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> client</h3><div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L47">src/structures/CommandManager.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Client connected to this manager</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="commandSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">command<wbr/>Separator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L79">src/structures/CommandManager.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A string used to separate subcommand groups and subcommands</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="helpCmd" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> help<wbr/>Cmd</h3><div class="tsd-signature tsd-kind-icon">help<wbr/>Cmd<span class="tsd-signature-symbol">?:</span> <a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L55">src/structures/CommandManager.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Help command associated with this manager</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="prefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> prefix</h3><div class="tsd-signature tsd-kind-icon">prefix<span class="tsd-signature-symbol">:</span> <a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L63">src/structures/CommandManager.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A manager holding all guild-specific prefixes and a global prefix</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a name="baseApiUrl" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> base<wbr/>Api<wbr/>Url</h3><div class="tsd-signature tsd-kind-icon">base<wbr/>Api<wbr/>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://discord.com/api/v8"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L88">src/structures/CommandManager.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API URL</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="cache" class="tsd-anchor"></a><h3>cache</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> cache<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</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">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L120">src/structures/CommandManager.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API commands cache</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</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">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="commandsCount" class="tsd-anchor"></a><h3>commands<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> commandsCount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L128">src/structures/CommandManager.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Number of commands registered in this manager</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></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-class tsd-has-type-parameter"><a name="add" class="tsd-anchor"></a><h3>add</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">add<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">CommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L145">src/structures/CommandManager.ts:145</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Creates and registers command in the manager based on the given options</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>All commands have to be added to the instance <strong>before starting the bot</strong>. Adding commands while the bot is running is not possible and can cause issues.</p>
|
||||
<p>Command types</p>
|
||||
<ul>
|
||||
<li><a href="https://grz4na.github.io/commandbot-docs/interfaces/ChatCommandInit.html">CHAT</a> - message interactions using command prefixes or slash commands</li>
|
||||
<li><a href="https://grz4na.github.io/commandbot-docs/interfaces/ContextMenuCommandInit.html">USER</a> - right-click context menu interactions on users</li>
|
||||
<li><a href="https://grz4na.github.io/commandbot-docs/interfaces/ContextMenuCommandInit.html">MESSAGE</a> - right-click context menu interactions on messages</li>
|
||||
</ul>
|
||||
</dd></dl></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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>a type of command that will be created and added to this manager</p>
|
||||
</div></div></li><li><h5>options: <a href="../modules.html#CommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">CommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>an object containing all properties required to create this type of command</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A computed command object that inherits from <a href="Command.html">Command</a></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="arrayToMap" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> array<wbr/>To<wbr/>Map</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">array<wbr/>To<wbr/>Map<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L554">src/structures/CommandManager.ts:554</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Performs internal data type conversions</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>a: <a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="fetch" class="tsd-anchor"></a><h3>fetch</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L314">src/structures/CommandManager.ts:314</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Process an interaction</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>interaction object to fetch a command from</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h4><div><p>An InputManager containing all input data (command, arguments, target etc.)</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<T><span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, t<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L175">src/structures/CommandManager.ts:175</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get command registered in this manager</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>q: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command name or alias</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> t: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A command object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getApi" class="tsd-anchor"></a><h3>get<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, guild<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>, noCache<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L214">src/structures/CommandManager.ts:214</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Fetches command object from the Discord API</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord command ID</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guild: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> noCache: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span></h4><div><p>Discord command object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Cache</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Cache<span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, guildId<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-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L545">src/structures/CommandManager.ts:545</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Retrieves cache from the manager</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>q: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guildId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getIdApi" class="tsd-anchor"></a><h3>get<wbr/>Id<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Id<wbr/>Api<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#APICommandType" class="tsd-signature-type" data-tsd-kind="Type alias">APICommandType</a>, guild<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</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">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L249">src/structures/CommandManager.ts:249</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Fetches command ID by name from the Discord APi</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>name of the command</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#APICommandType" class="tsd-signature-type" data-tsd-kind="Type alias">APICommandType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type you want to get ID for</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guild: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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">string</span><span class="tsd-signature-symbol">></span></h4><div><p>Command ID from the Discord API</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getPermissionsApi" class="tsd-anchor"></a><h3>get<wbr/>Permissions<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Permissions<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, g<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L507">src/structures/CommandManager.ts:507</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get permissions from Discord Permissions API for a specified command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command ID</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="list" class="tsd-anchor"></a><h3>list</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"CONTEXT"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L267">src/structures/CommandManager.ts:267</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Lists all commands in the manager</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span></h4><div><p>An array of commands registered in this manager</p>
|
||||
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L268">src/structures/CommandManager.ts:268</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>f: <span class="tsd-signature-type">"CHAT"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol">[]</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L269">src/structures/CommandManager.ts:269</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>f: <span class="tsd-signature-type">"CONTEXT"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="listApi" class="tsd-anchor"></a><h3>list<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<wbr/>Api<span class="tsd-signature-symbol">(</span>g<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L288">src/structures/CommandManager.ts:288</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Lists commands registered in the Discord API</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>List of commands from Discord API</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="register" class="tsd-anchor"></a><h3>register</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L420">src/structures/CommandManager.ts:420</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Register all commands in this manager in the Discord API</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="setPermissionsApi" class="tsd-anchor"></a><h3>set<wbr/>Permissions<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Permissions<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, permissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span>, g<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L482">src/structures/CommandManager.ts:482</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Set permissions using Discord Permissions API</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command ID</p>
|
||||
</div></div></li><li><h5>permissions: <a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>permissions to set</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="updateCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> update<wbr/>Cache</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">update<wbr/>Cache<span class="tsd-signature-symbol">(</span>commands<span class="tsd-signature-symbol">: </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span>, guildId<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-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L530">src/structures/CommandManager.ts:530</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>commands: <a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>list of commands to cache</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guildId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>guild ID</p>
|
||||
</div></div></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-class tsd-is-static"><a name="isCommand" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Command</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<span class="tsd-signature-symbol">(</span>c<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">c</span><span class="tsd-signature-symbol"> is </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandManager.ts#L568">src/structures/CommandManager.ts:568</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>c: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object to check</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">c</span><span class="tsd-signature-symbol"> is </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h4><div><p>Whether this object is a <a href="Command.html">Command</a> object</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CommandManager.html" class="tsd-kind-icon">Command<wbr/>Manager</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CommandManager.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_commands" class="tsd-kind-icon">_commands</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_globalEntryName" class="tsd-kind-icon">_global<wbr/>Entry<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_registerCache" class="tsd-kind-icon">_register<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#helpCmd" class="tsd-kind-icon">help<wbr/>Cmd</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#prefix" class="tsd-kind-icon">prefix</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#baseApiUrl" class="tsd-kind-icon">base<wbr/>Api<wbr/>Url</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#cache" class="tsd-kind-icon">cache</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#commandsCount" class="tsd-kind-icon">commands<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="CommandManager.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#arrayToMap" class="tsd-kind-icon">array<wbr/>To<wbr/>Map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="CommandManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getApi" class="tsd-kind-icon">get<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#getCache" class="tsd-kind-icon">get<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getIdApi" class="tsd-kind-icon">get<wbr/>Id<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getPermissionsApi" class="tsd-kind-icon">get<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#listApi" class="tsd-kind-icon">list<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#register" class="tsd-kind-icon">register</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#setPermissionsApi" class="tsd-kind-icon">set<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#updateCache" class="tsd-kind-icon">update<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#isCommand" class="tsd-kind-icon">is<wbr/>Command</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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<Line truncated
|
||||
@@ -0,0 +1,20 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandPermissions | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="CommandPermissions.html">CommandPermissions</a></li></ul><h1>Class CommandPermissions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object that stores permission resolvables and properties (bouund to a <a href="PermissionCommand.html">PermissionCommand</a>)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandPermissions</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CommandPermissions.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#permissions" class="tsd-kind-icon">permissions</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#bitfield" class="tsd-kind-icon">bitfield</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#isCustom" class="tsd-kind-icon">is<wbr/>Custom</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-class"><a href="CommandPermissions.html#check" class="tsd-kind-icon">check</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Command<wbr/>Permissions<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a>, o<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandPermissions.ts#L39">src/structures/CommandPermissions.ts:39</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command attached to this permissions object</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> o: <a href="../interfaces/CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></h4></li></ul></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-class"><a name="checkType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> check<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#PermissionCheckTypes" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionCheckTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandPermissions.ts#L32">src/structures/CommandPermissions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command permissions</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandPermissions.ts#L16">src/structures/CommandPermissions.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command bound to this object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="../modules.html#PermissionFunction" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionFunction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Permissions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandPermissions.ts#L24">src/structures/CommandPermissions.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to "ALL", the command can only be used when all specified conditions are met. (works only for Discord.js permissions object)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="bitfield" class="tsd-anchor"></a><h3>bitfield</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bitfield<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInt</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandPermissions.ts#L57">src/structures/CommandPermissions.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Permission bitfield</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BigInt</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="isCustom" class="tsd-anchor"></a><h3>is<wbr/>Custom</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isCustom<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 <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandPermissions.ts#L49">src/structures/CommandPermissions.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this object uses custom function to check permissions</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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-class"><a name="check" class="tsd-anchor"></a><h3>check</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</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 <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/CommandPermissions.ts#L67">src/structures/CommandPermissions.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks if the interaction sender is permitted to use the command attached to this object</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command interaction or Discord message</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Whether a sender can use the command bound to this object</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CommandPermissions.html" class="tsd-kind-icon">Command<wbr/>Permissions</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CommandPermissions.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#bitfield" class="tsd-kind-icon">bitfield</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#isCustom" class="tsd-kind-icon">is<wbr/>Custom</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandPermissions.html#check" class="tsd-kind-icon">check</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,47 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ContextMenuCommand | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ContextMenuCommand.html">ContextMenuCommand</a></li></ul><h1>Class ContextMenuCommand</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Representation of all context menu Discord interactions</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><ul class="tsd-hierarchy"><li><span class="target">ContextMenuCommand</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ContextMenuCommand.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#type" class="tsd-kind-icon">type</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-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Context<wbr/>Menu<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, options<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-symbol">: </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ContextMenuCommand.ts#L26">src/commands/ContextMenuCommand.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Context menu command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>manager that this command belongs to</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a></h4></li></ul></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-class tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="contextType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">context<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ContextType" class="tsd-signature-type" data-tsd-kind="Type alias">ContextType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ContextMenuCommand.ts#L18">src/commands/ContextMenuCommand.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Type of context menu interaction</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L58">src/commands/base/PermissionGuildCommand.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ContextMenuCommand.ts#L43">src/commands/ContextMenuCommand.ts:43</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></h4><div><p>Discord API object</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ContextMenuCommand.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ContextMenuCommand.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,52 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>FunctionCommand | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="FunctionCommand.html">FunctionCommand</a></li></ul><h1>Class FunctionCommand</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Function (executable) command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><ul class="tsd-hierarchy"><li><span class="target">FunctionCommand</span><ul class="tsd-hierarchy"><li><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></li><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></li></ul></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="FunctionCommand.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FunctionCommand.html#_function" class="tsd-kind-icon">_function</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#type" class="tsd-kind-icon">type</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-class tsd-is-private"><a href="FunctionCommand.html#handleReply" class="tsd-kind-icon">handle<wbr/>Reply</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="FunctionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Function<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L37">src/commands/base/FunctionCommand.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Executable command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initailization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></h4></li></ul></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-class tsd-is-private"><a name="_function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _function</h3><div class="tsd-signature tsd-kind-icon">_function<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L21">src/commands/base/FunctionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (called on command execution)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</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/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-is-private"><a name="handleReply" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> handle<wbr/>Reply</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">handle<wbr/>Reply<span class="tsd-signature-symbol">(</span>interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span>, result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</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-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L73">src/commands/base/FunctionCommand.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Reply handler</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction object</p>
|
||||
</div></div></li><li><h5>result: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</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></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>result of command function execution</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L59">src/commands/base/FunctionCommand.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data manager</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div><p>A <em>Promise</em> that resolves after the function command is completed</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="FunctionCommand.html" class="tsd-kind-icon">Function<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="FunctionCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FunctionCommand.html#_function" class="tsd-kind-icon">_function</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FunctionCommand.html#handleReply" class="tsd-kind-icon">handle<wbr/>Reply</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="FunctionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,47 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>GuildCommand | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="GuildCommand.html">GuildCommand</a></li></ul><h1>Class GuildCommand</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Guild-scoped executable command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><ul class="tsd-hierarchy"><li><span class="target">GuildCommand</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#type" class="tsd-kind-icon">type</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-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Guild<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/GuildCommand.ts#L36">src/commands/base/GuildCommand.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Guild-scoped command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></h4></li></ul></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-class tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">:</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/aa6cb8b/src/commands/base/GuildCommand.ts#L27">src/commands/base/GuildCommand.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/GuildCommand.ts#L19">src/commands/base/GuildCommand.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/GuildCommand.ts#L55">src/commands/base/GuildCommand.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="GuildCommand.html" class="tsd-kind-icon">Guild<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,81 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>HelpMessage | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="HelpMessage.html">HelpMessage</a></li></ul><h1>Class HelpMessage</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><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><ul class="tsd-hierarchy"><li><span class="target">HelpMessage</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="HelpMessage.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="HelpMessage.html#_appearance" class="tsd-kind-icon">_appearance</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#visible" class="tsd-kLine truncated
|
||||
<p>Help message constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cmdManager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager related to this command</p>
|
||||
</div></div></li><li><h5>appearance: <a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>appearance properties</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</a></h4></li></ul></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-class tsd-is-private"><a name="_appearance" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _appearance</h3><div class="tsd-signature tsd-kind-icon">_appearance<span class="tsd-signature-symbol">:</span> <a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/Help.ts#L18">src/commands/Help.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Help message appearance options</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> aliases</h3><div class="tsd-signature tsd-kind-icon">aliases<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#aliases">aliases</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L41">src/commands/ChatCommand.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of different names that can be used to invoke a command (when using prefix interactions)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#description">description</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L49">src/commands/ChatCommand.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description displayed in the help message or in slash commands menu (Default description: "No description")</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><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></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#parameters">parameters</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L33">src/commands/ChatCommand.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of parameters that can passed to this command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> slash</h3><div class="tsd-signature tsd-kind-icon">slash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#slash">slash</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L73">src/commands/ChatCommand.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be registered as a slash command (default: true)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> usage</h3><div class="tsd-signature tsd-kind-icon">usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#usage">usage</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L57">src/commands/ChatCommand.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage displayed in the help message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> visible</h3><div class="tsd-signature tsd-kind-icon">visible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#visible">visible</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L65">src/commands/ChatCommand.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command is visible in the help message (default: true)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L141">src/commands/ChatCommand.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns list of attached subcommands</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a name="hasSubCommands" class="tsd-anchor"></a><h3>has<wbr/>Sub<wbr/>Commands</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasSubCommands<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 <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L132">src/commands/ChatCommand.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns <em>true</em> if the command has subcommands attached</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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-class tsd-has-type-parameter tsd-is-inherited"><a name="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">append<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#append">append</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L166">src/commands/ChatCommand.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Attaches subcommand or subcommand group to this ChatCommand (this makes the base command usable only via prefix interactions)</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand type</p>
|
||||
</div></div></li><li><h5>options: <a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A computed subcommand object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="fetchSubcommand" class="tsd-anchor"></a><h3>fetch<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#fetchSubcommand">fetchSubcommand</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L191">src/commands/ChatCommand.ts:191</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter options</p>
|
||||
</div></div></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h4><div><p>an <a href="InputManager.html">InputManager</a> containing all interaction-related data or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="generateMessage" class="tsd-anchor"></a><h3>generate<wbr/>Message</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Message<span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span>, cmdName<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-type">MessageEmbed</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/Help.ts#L53">src/commands/Help.ts:53</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cmdName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessageEmbed</span></h4><div><p>A computed help message in form of {@link MessageEmbed}</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="getSubcommand" class="tsd-anchor"></a><h3>get<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, group<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-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#getSubcommand">getSubcommand</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L250">src/commands/ChatCommand.ts:250</a></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><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand name</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> group: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></h4><div><p>a <a href="SubCommand.html">SubCommand</a> object or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L152">src/commands/ChatCommand.ts:152</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data manager</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/ChatCommand.ts#L269">src/commands/ChatCommand.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts <a href="ChatCommand.html">ChatCommand</a> instance to object that is recognized by the Discord API</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></h4><div><p>Discord API object</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="HelpMessage.html" class="tsd-kind-icon">Help<wbr/>Message</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="HelpMessage.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="HelpMessage.html#_appearance" class="tsd-kind-icon">_appearance</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#visible" class="tsd-kind-icon">visible</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#hasSubCommands" class="tsd-kind-icon">has<wbr/>Sub<wbr/>Commands</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#fetchSubcommand" class="tsd-kind-icon">fetch<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="HelpMessage.html#generateMessage" class="tsd-kind-icon">generate<wbr/>Message</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#getSubcommand" class="tsd-kind-icon">get<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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 Line truncated
|
||||
@@ -0,0 +1,24 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>InputManager | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="InputManager.html">InputManager</a></li></ul><h1>Class InputManager</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object that stores all interaction input data (target, arguments, content and the interaction itself)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">InputManager</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="InputManager.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="InputManager.html#arguments" class="tsd-kind-icon">arguments</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#target" class="tsd-kind-icon">target</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-class tsd-has-type-parameter"><a href="InputManager.html#get" class="tsd-kind-icon">get</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Input<wbr/>Manager<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span>, args<span class="tsd-signature-symbol">: </span><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><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>, target<span class="tsd-signature-symbol">?: </span><a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><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-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/InputManager.ts#L51">src/structures/InputManager.ts:51</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command related to this manager</p>
|
||||
</div></div></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>interaction or message</p>
|
||||
</div></div></li><li><h5>args: <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><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></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>list of input arguments</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> target: <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h4></li></ul></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-class tsd-is-private"><a name="arguments" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> arguments</h3><div class="tsd-signature tsd-kind-icon">arguments<span class="tsd-signature-symbol">:</span> <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/InputManager.ts#L42">src/structures/InputManager.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>All input arguments</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/InputManager.ts#L18">src/structures/InputManager.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command related to this manager</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="interaction" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> interaction</h3><div class="tsd-signature tsd-kind-icon">interaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/InputManager.ts#L26">src/structures/InputManager.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command interaction or message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="target" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> target</h3><div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">?:</span> <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/InputManager.ts#L34">src/structures/InputManager.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command target (when using context menu interactions)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-has-type-parameter"><a name="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<T><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/InputManager.ts#L65">src/structures/InputManager.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get input values</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>query: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter name</p>
|
||||
</div></div></li><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Argument value bound to a parameter</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="InputManager.html" class="tsd-kind-icon">Input<wbr/>Manager</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="InputManager.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="InputManager.html#arguments" class="tsd-kind-icon">arguments</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#target" class="tsd-kind-icon">target</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="InputManager.html#get" class="tsd-kind-icon">get</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>InputParameter | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="InputParameter.html">InputParameter</a></li></ul><h1>Class InputParameter<T></h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter with input value from interaction (reffered to as argument)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><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-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">InputParameter</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="InputParameter.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputParameter.html#value" class="tsd-kind-icon">value</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Input<wbr/>Parameter<T><span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#constructor">constructor</a></p><ul><li>Defined in src/structures/parameter.ts:125</li></ul></aside><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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>param: <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-sLine truncated
|
||||
<p>parent parameter</p>
|
||||
</div></div></li><li><h5>value: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input value</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></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-class tsd-is-inherited"><a name="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#choices">choices</a></p><ul><li>Defined in src/structures/parameter.ts:56</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of value choices (available only when type is set to "STRING")</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#command">command</a></p><ul><li>Defined in src/structures/parameter.ts:17</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command associated with this parameter</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#description">description</a></p><ul><li>Defined in src/structures/parameter.ts:32</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#name">name</a></p><ul><li>Defined in src/structures/parameter.ts:24</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="optional" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> optional</h3><div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#optional">optional</a></p><ul><li>Defined in src/structures/parameter.ts:40</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is optional</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#type">type</a></p><ul><li>Defined in src/structures/parameter.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter input type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="value" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> value</h3><div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:118</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Value of an argument</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a name="descriptionRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> description<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">description<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#descriptionRegExp">descriptionRegExp</a></p><ul><li>Defined in src/structures/parameter.ts:72</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a name="nameRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> name<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">name<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#nameRegExp">nameRegExp</a></p><ul><li>Defined in src/structures/parameter.ts:64</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-has-type-parameter"><a href="InputParameter.html" class="tsd-kind-icon">Input<wbr/>Parameter</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="InputParameter.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputParameter.html#value" class="tsd-kind-icon">value</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,15 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>MissingParameterError | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="MissingParameterError.html">MissingParameterError</a></li></ul><h1>Class MissingParameterError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Error indicating that a required parameter is missing in the request</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">ReferenceError</span><ul class="tsd-hierarchy"><li><span class="target">MissingParameterError</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="MissingParameterError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="MissingParameterError.html#argument" class="tsd-kind-icon">argument</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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-class"><a href="MissingParameterError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Missing<wbr/>Parameter<wbr/>Error<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><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-symbol">: </span><a href="MissingParameterError.html" class="tsd-signature-type" data-tsd-kind="Class">MissingParameterError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides ReferenceError.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L108">src/errors.ts:108</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>a: <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>missing parameter object</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="MissingParameterError.html" class="tsd-signature-type" data-tsd-kind="Class">MissingParameterError</a></h4></li></ul></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-class tsd-is-private"><a name="argument" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> argument</h3><div class="tsd-signature tsd-kind-icon">argument<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L102">src/errors.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Missing parameter object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="message" class="tsd-anchor"></a><h3>message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</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-class"><a name="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L118">src/errors.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts error object to user-readable message</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Formatted error message</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</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"><p>Inherited from ReferenceError.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Create .stack property on a target object</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</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-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from ReferenceError.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional override for formatting stack traces</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="MissingParameterError.html" class="tsd-kind-icon">Missing<wbr/>Parameter<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="MissingParameterError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="MissingParameterError.html#argument" class="tsd-kind-icon">argument</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MissingParameterError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,16 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ObjectID | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ObjectID.html">ObjectID</a></li></ul><h1>Class ObjectID<T></h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Wrapped representation of Discord user, role, channel or other mentionable Discord arugment object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><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-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ObjectID</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="ObjectID.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#guild" class="tsd-kind-icon">guild</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#type" class="tsd-kind-icon">type</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-class"><a href="ObjectID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>ObjectID<T><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, guild<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Guild</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:214</li></ul></aside><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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object Discord ID</p>
|
||||
</div></div></li><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object type</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guild: <span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></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-class"><a name="guild" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guild</h3><div class="tsd-signature tsd-kind-icon">guild<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Guild</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:199</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Guild needed to convert the object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:192</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object ID</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:206</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ObjectIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:226</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Uses informations associated with the object to generate a Discord.js representation</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ObjectIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>A fetched object (or null)</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-has-type-parameter"><a href="ObjectID.html" class="tsd-kind-icon">ObjectID</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="ObjectID.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#guild" class="tsd-kind-icon">guild</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ObjectID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>OperationSuccess | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="OperationSuccess.html">OperationSuccess</a></li></ul><h1>Class OperationSuccess</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object indicating command execution success</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">OperationSuccess</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="OperationSuccess.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="OperationSuccess.html#command" class="tsd-kind-icon">command</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Operation<wbr/>Success<span class="tsd-signature-symbol">(</span>c<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="OperationSuccess.html" class="tsd-signature-type" data-tsd-kind="Class">OperationSuccess</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L140">src/errors.ts:140</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>c: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command that succeeded</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="OperationSuccess.html" class="tsd-signature-type" data-tsd-kind="Class">OperationSuccess</a></h4></li></ul></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-class"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L134">src/errors.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command that succeeded</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="OperationSuccess.html" class="tsd-kind-icon">Operation<wbr/>Success</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="OperationSuccess.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="OperationSuccess.html#command" class="tsd-kind-icon">command</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,23 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Parameter | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="Parameter.html">Parameter</a></li></ul><h1>Class Parameter<T></h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Representation of command parameter</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><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-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Parameter</span><ul class="tsd-hierarchy"><li><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="Parameter.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Parameter<T><span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:79</li></ul></aside><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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter parent command</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>options used to compute a Parameter object</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></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-class"><a name="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:56</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of value choices (available only when type is set to "STRING")</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:17</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command associated with this parameter</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:32</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:24</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="optional" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> optional</h3><div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:40</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is optional</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter input type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a name="descriptionRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> description<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">description<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:72</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a name="nameRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> name<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">name<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:64</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-has-type-parameter"><a href="Parameter.html" class="tsd-kind-icon">Parameter</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="Parameter.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,19 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ParameterTypeError | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ParameterTypeError.html">ParameterTypeError</a></li></ul><h1>Class ParameterTypeError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Error indicating that an input value cannot be converted to a expected type</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypeError</span><ul class="tsd-hierarchy"><li><span class="target">ParameterTypeError</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ParameterTypeError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#stringContent" class="tsd-kind-icon">string<wbr/>Content</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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-class"><a href="ParameterTypeError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Parameter<wbr/>Type<wbr/>Error<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterResolvable</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ParameterTypeError.html" class="tsd-signature-type" data-tsd-kind="Class">ParameterTypeError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides TypeError.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L74">src/errors.ts:74</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>s: <a href="../modules.html#ParameterResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterResolvable</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>value with an invalid type</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>expected type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ParameterTypeError.html" class="tsd-signature-type" data-tsd-kind="Class">ParameterTypeError</a></h4></li></ul></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-class tsd-is-inherited tsd-is-external"><a name="message" class="tsd-anchor"></a><h3>message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from TypeError.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from TypeError.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from TypeError.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="stringContent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> string<wbr/>Content</h3><div class="tsd-signature tsd-kind-icon">string<wbr/>Content<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L60">src/errors.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Value converted to a string</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L67">src/errors.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Expected type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from TypeError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</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-class"><a name="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L85">src/errors.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts error object to user-readable message</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Formatted error message</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</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"><p>Inherited from TypeError.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Create .stack property on a target object</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</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-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from TypeError.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional override for formatting stack traces</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ParameterTypeError.html" class="tsd-kind-icon">Parameter<wbr/>Type<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ParameterTypeError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#stringContent" class="tsd-kind-icon">string<wbr/>Content</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ParameterTypeError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,45 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionCommand | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="PermissionCommand.html">PermissionCommand</a></li></ul><h1>Class PermissionCommand</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Executable command with attached permission system</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><ul class="tsd-hierarchy"><li><span class="target">PermissionCommand</span><ul class="tsd-hierarchy"><li><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></li></ul></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#type" class="tsd-kind-icon">type</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-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permission<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L30">src/commands/base/PermissionCommand.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Constructor of command with attached permissions</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initalization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></h4></li></ul></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-class tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L48">src/commands/base/PermissionCommand.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="PermissionCommand.html" class="tsd-kind-icon">Permission<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,50 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionGuildCommand | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="PermissionGuildCommand.html">PermissionGuildCommand</a></li></ul><h1>Class PermissionGuildCommand</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Guild-scoped executable command with permissions attached</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>implements</dt><dd><p>{GuildCommand}</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><ul class="tsd-hierarchy"><li><span class="target">PermissionGuildCommand</span><ul class="tsd-hierarchy"><li><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></li><li><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a></li></ul></li></ul></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#type" class="tsd-kind-icon">type</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-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permission<wbr/>Guild<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commandLine truncated
|
||||
<p>Guild-scoped, executable, permissions command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></h4></li></ul></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-class tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of GuildCommand.announceSuccess</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of GuildCommand.default_permission</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of GuildCommand.dm</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Implementation of GuildCommand.guilds</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.manager</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of GuildCommand.name</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.type</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isBaseCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isChildCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.start</p><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionGuildCommand.ts#L58">src/commands/base/PermissionGuildCommand.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.toObject</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="PermissionGuildCommand.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,17 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionsError | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="PermissionsError.html">PermissionsError</a></li></ul><h1>Class PermissionsError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Error indicating that a caller doesn't have enough permissions to execute a command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">PermissionsError</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionsError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionsError.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionsError.html#user" class="tsd-kind-icon">user</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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-class"><a href="PermissionsError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permissions<wbr/>Error<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a>, user<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L32">src/errors.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command that user wanted and failed to invoke</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> user: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</a></h4></li></ul></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-class tsd-is-private"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L18">src/errors.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command that user wanted and failed to invoke</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="message" class="tsd-anchor"></a><h3>message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="user" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> user</h3><div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L25">src/errors.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>User that doesn't have the permissions</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</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-class"><a name="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/errors.ts#L43">src/errors.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts error object to user-readable message</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Formatted error message</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</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"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Create .stack property on a target object</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</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-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional override for formatting stack traces</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="PermissionsError.html" class="tsd-kind-icon">Permissions<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionsError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionsError.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionsError.html#user" class="tsd-kind-icon">user</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PermissionsError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,22 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PrefixManager | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="PrefixManager.html">PrefixManager</a></li></ul><h1>Class PrefixManager</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">PrefixManager</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PrefixManager.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PrefixManager.html#_global" class="tsd-kind-icon">_global</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PrefixManager.html#_prefixes" class="tsd-kind-icon">_prefixes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PrefixManager.html#manager" class="tsd-kind-icon">manager</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PrefixManager.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</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-class"><a href="PrefixManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#remove" class="tsd-kind-icon">remove</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#set" class="tsd-kind-icon">set</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Prefix<wbr/>Manager<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, defaultPrefix<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><a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L34">src/structures/PrefixManager.ts:34</a></li></ul></aside><h4 class="tsd-parameters-titLine truncated
|
||||
<p>manager attached to this object</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultPrefix: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</a></h4></li></ul></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-class tsd-is-private"><a name="_global" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _global</h3><div class="tsd-signature tsd-kind-icon">_global<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "GLOBAL"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L20">src/structures/PrefixManager.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Global scope identifier</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="_prefixes" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _prefixes</h3><div class="tsd-signature tsd-kind-icon">_prefixes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</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">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L13">src/structures/PrefixManager.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Prefixes data</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L27">src/structures/PrefixManager.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command manager associated with the object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="globalPrefix" class="tsd-anchor"></a><h3>global<wbr/>Prefix</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> globalPrefix<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L48">src/structures/PrefixManager.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager global prefix</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></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-class"><a name="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</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">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L58">src/structures/PrefixManager.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get prefix for a specified scope</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>guild object or ID</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><div><p>a prefix used in given scope</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="remove" class="tsd-anchor"></a><h3>remove</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><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 <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L90">src/structures/PrefixManager.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Remove prefix for the specified scope</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a></h5></li></ul><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-class"><a name="set" class="tsd-anchor"></a><h3>set</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/PrefixManager.ts#L73">src/structures/PrefixManager.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Set prefix for a specific scope</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>prefix: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>new prefix</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="PrefixManager.html" class="tsd-kind-icon">Prefix<wbr/>Manager</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PrefixManager.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PrefixManager.html#_global" class="tsd-kind-icon">_global</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PrefixManager.html#_prefixes" class="tsd-kind-icon">_prefixes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PrefixManager.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PrefixManager.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#remove" class="tsd-kind-icon">remove</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#set" class="tsd-kind-icon">set</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,49 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommand | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SubCommand.html">SubCommand</a></li></ul><h1>Class SubCommand</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Representation of SUB_COMMAND Discord interaction</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><ul class="tsd-hierarchy"><li><span class="target">SubCommand</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#usage" class="tsd-kind-icon">usage</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-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sub<wbr/>Command<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a>, options<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-symbol">: </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommand.ts#L54">src/commands/SubCommand.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Subcommand constructor (SUB_COMMAND parameter in Discord API)</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command parent</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></h4></li></ul></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-class tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommand.ts#L30">src/commands/SubCommand.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description displayed in the help message or in slash commands menu (Default description: "No description")</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommand.ts#L38">src/commands/SubCommand.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of parameters that can passed to this command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="parent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parent</h3><div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommand.ts#L22">src/commands/SubCommand.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command parent</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> usage</h3><div class="tsd-signature tsd-kind-icon">usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommand.ts#L46">src/commands/SubCommand.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage displayed in the help message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommand.ts#L90">src/commands/SubCommand.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommand.ts#L106">src/commands/SubCommand.ts:106</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></h4><div><p>Discord API object</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,44 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandGroup | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SubCommandGroup.html">SubCommandGroup</a></li></ul><h1>Class SubCommandGroup</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Group of subcommands</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroup</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="SubCommandGroup.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#type" class="tsd-kind-icon">type</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="SubCommandGroup.html#children" class="tsd-kind-icon">children</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-class"><a href="SubCommandGroup.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sub<wbr/>Command<wbr/>Group<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a>, options<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-symbol">: </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommandGroup.ts#L42">src/commands/SubCommandGroup.ts:42</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>group parent command</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></h4></li></ul></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-class tsd-is-private"><a name="_children" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _children</h3><div class="tsd-signature tsd-kind-icon">_children<span class="tsd-signature-symbol">:</span> <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommandGroup.ts#L19">src/commands/SubCommandGroup.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Group members (children)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommandGroup.ts#L35">src/commands/SubCommandGroup.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Group description (default: "No description")</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="parent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parent</h3><div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommandGroup.ts#L27">src/commands/SubCommandGroup.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Group parent command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommandGroup.ts#L64">src/commands/SubCommandGroup.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of subcommands attached to this group</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></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-class"><a name="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">append<span class="tsd-signature-symbol">(</span>options<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-symbol">: </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommandGroup.ts#L74">src/commands/SubCommandGroup.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Attach a subcommand to this group</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></h4><div><p>A computed <a href="SubCommand.html">SubCommand</a> object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/SubCommandGroup.ts#L88">src/commands/SubCommandGroup.ts:88</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></h4><div><p>Discord API object</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="SubCommandGroup.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="SubCommandGroup.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="SubCommandGroup.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SubCommandGroup.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,24 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SystemMessageManager | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SystemMessageManager.html">SystemMessageManager</a></li></ul><h1>Class SystemMessageManager</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Stores configuration and generates system messages</p>
|
||||
</div><div><p>System messages - predefined messages sent by the bot in special cases (for example after an error, or when a command doesn't exist)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>You can't customize messages after starting the bot. Changing these properties while the bot is running will have no effect.</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SystemMessageManager</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="SystemMessageManager.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#ERROR" class="tsd-kind-icon">ERROR</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#NOT_FOUND" class="tsd-kind-icon">NOT_<wbr/>FOUND</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#PERMISSION" class="tsd-kind-icon">PERMISSION</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#SUCCESS" class="tsd-kind-icon">SUCCESS</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</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-class"><a href="SystemMessageManager.html#send" class="tsd-kind-icon">send</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>System<wbr/>Message<wbr/>Manager<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a>, botName<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><a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L59">src/structures/SystemMessage.ts:59</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> botName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</a></h4></li></ul></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-class"><a name="ERROR" class="tsd-anchor"></a><h3>ERROR</h3><div class="tsd-signature tsd-kind-icon">ERROR<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L34">src/structures/SystemMessage.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Sent when an error occurs during the execution of a command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="NOT_FOUND" class="tsd-anchor"></a><h3>NOT_<wbr/>FOUND</h3><div class="tsd-signature tsd-kind-icon">NOT_<wbr/>FOUND<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L41">src/structures/SystemMessage.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Sent when someone tries to run a command that does not exist (mainly by using prefix interactions)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="PERMISSION" class="tsd-anchor"></a><h3>PERMISSION</h3><div class="tsd-signature tsd-kind-icon">PERMISSION<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L27">src/structures/SystemMessage.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Sent whenever caller's permissions are not sufficient to run a command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="SUCCESS" class="tsd-anchor"></a><h3>SUCCESS</h3><div class="tsd-signature tsd-kind-icon">SUCCESS<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L49">src/structures/SystemMessage.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Sent when a command function returns <em>void</em> without throwing an error</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>An <em>announceSuccess</em> property must be set to <em>true</em> (default) in order to send this message</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="client" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> client</h3><div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L21">src/structures/SystemMessage.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Client parent attached to this manager</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="deleteTimeout" class="tsd-anchor"></a><h3>delete<wbr/>Timeout</h3><div class="tsd-signature tsd-kind-icon">delete<wbr/>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L57">src/structures/SystemMessage.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Global time (in ms) after a message gets deleted</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This time applies to all message types but it can be overwritten using local properties with the same name (for example ERROR.deleteTimeout)</p>
|
||||
</dd></dl></div></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-class"><a name="send" class="tsd-anchor"></a><h3>send</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules.html#MessageType" class="tsd-signature-type" data-tsd-kind="Type alias">MessageType</a>, data<span class="tsd-signature-symbol">?: </span><a href="../interfaces/SystemMessageData.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageData</a>, interaction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</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">DMChannel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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">MessageEmbed</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/SystemMessage.ts#L108">src/structures/SystemMessage.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Generates and sends a system message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <a href="../modules.html#MessageType" class="tsd-signature-type" data-tsd-kind="Type alias">MessageType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>"ERROR" | "PERMISSION" | "NOT_FOUND" | "SUCCESS"</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <a href="../interfaces/SystemMessageData.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageData</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</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">DMChannel</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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">MessageEmbed</span><span class="tsd-signature-symbol">></span></h4><div><p>A message that got sent or <em>void</em></p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="SystemMessageManager.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Manager</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="SystemMessageManager.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#ERROR" class="tsd-kind-icon">ERROR</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#NOT_FOUND" class="tsd-kind-icon">NOT_<wbr/>FOUND</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#PERMISSION" class="tsd-kind-icon">PERMISSION</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#SUCCESS" class="tsd-kind-icon">SUCCESS</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SystemMessageManager.html#send" class="tsd-kind-icon">send</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,14 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TargetID | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="TargetID.html">TargetID</a></li></ul><h1>Class TargetID<T></h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Wrapped representation of Discord target object (target of context menu interactions)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><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-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TargetID</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="TargetID.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="TargetID.html#type" class="tsd-kind-icon">type</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-class"><a href="TargetID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>TargetID<T><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:272</li></ul></aside><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><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object Discord ID</p>
|
||||
</div></div></li><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></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-class"><a name="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:250</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object ID</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="interaction" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> interaction</h3><div class="tsd-signature tsd-kind-icon">interaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:257</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Interaction associated with the target</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:264</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Target type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></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-class"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#TargetIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/structures/parameter.ts:284</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Uses informations associated with the object to generate a Discord.js representation</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#TargetIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A fetched object (or null)</p>
|
||||
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-has-type-parameter"><a href="TargetID.html" class="tsd-kind-icon">TargetID</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="TargetID.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="TargetID.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TargetID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
+199
@@ -0,0 +1,199 @@
|
||||
<!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"><div class="tsd-panel tsd-typography">
|
||||
<a href="#commandbot" id="commandbot" style="color: inherit; text-decoration: none;">
|
||||
<h1>CommandBot</h1>
|
||||
</a>
|
||||
<p>A Discord.js based framework that makes creating Discord bots with support for slash commands easy and fast.</p>
|
||||
|
||||
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
|
||||
<h2>Features</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li>Support for slash commands, context menu interactions</li>
|
||||
<li>Intuitive usage</li>
|
||||
<li>Flexible</li>
|
||||
<li>Good customization</li>
|
||||
<li>Permission system</li>
|
||||
<li>Built-in help command</li>
|
||||
<li>Built-in information messages</li>
|
||||
<li>Automatic error catching</li>
|
||||
<li>Large documentation in README and using JSDoc</li>
|
||||
<li>Written in TypeScript</li>
|
||||
</ul>
|
||||
|
||||
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
|
||||
<h2>Documentation</h2>
|
||||
</a>
|
||||
<p>Reference for available objects and structures is available <a href="https://grz4na.github.io/commandbot/"><strong>here</strong></a>. All descriptions can also be accessed from your code editor/IDE. TypeScript declaration files are also included (.d.ts) for some programs (like Visual Studio Code) to give autocompletion suggestions.</p>
|
||||
|
||||
<a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;">
|
||||
<h2>Table of contents</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li><a href="#commandbot">CommandBot</a><ul>
|
||||
<li><a href="#features">Features</a></li>
|
||||
<li><a href="#documentation">Documentation</a></li>
|
||||
<li><a href="#table-of-contents">Table of contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#installation">Instalation</a><ul>
|
||||
<li><a href="#system-requirements">System requirements</a></li>
|
||||
<li><a href="#creating-a-project">Creating a project</a><ul>
|
||||
<li><a href="#registering-discord-app">Registering Discord app</a></li>
|
||||
<li><a href="#creating-application">Creating application</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#commands">Commands</a><ul>
|
||||
<li><a href="#creating-a-command">Creating a command</a></li>
|
||||
<li><a href="#parameters">Parameters</a><ul>
|
||||
<li><a href="#types">Types</a></li>
|
||||
<li><a href="#defining">Defining</a></li>
|
||||
<li><a href="#reading-input-value">Reading input value</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#events">Events</a></li>
|
||||
<li><a href="#messages">Messages</a><ul>
|
||||
<li><a href="#system-messages">System messages</a></li>
|
||||
<li><a href="#help-message">Help message</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#issues">Issues</a></li>
|
||||
</ul>
|
||||
|
||||
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
||||
<h1>Installation</h1>
|
||||
</a>
|
||||
|
||||
<a href="#system-requirements" id="system-requirements" style="color: inherit; text-decoration: none;">
|
||||
<h2>System requirements</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li><em>Node.js</em> 16.6.0 or newer</li>
|
||||
<li><em>npm</em> or <em>yarn</em> package manager</li>
|
||||
</ul>
|
||||
|
||||
<a href="#creating-a-project" id="creating-a-project" style="color: inherit; text-decoration: none;">
|
||||
<h2>Creating a project</h2>
|
||||
</a>
|
||||
|
||||
<a href="#registering-discord-app" id="registering-discord-app" style="color: inherit; text-decoration: none;">
|
||||
<h3>Registering Discord app</h3>
|
||||
</a>
|
||||
<ol>
|
||||
<li>Visit <a href="https://discord.com/developers/">Discord Developer Portal</a> and create an app</li>
|
||||
<li>Navigate to the <em>Bot</em> section and register a bot</li>
|
||||
<li>Navigate to <em>OAuth 2</em> section, select <em>bot</em> and <em>application.commands</em> scopes and check bot permissions</li>
|
||||
<li>Copy the link, paste it in your web browser and add the bot to a server</li>
|
||||
</ol>
|
||||
|
||||
<a href="#creating-application" id="creating-application" style="color: inherit; text-decoration: none;">
|
||||
<h3>Creating application</h3>
|
||||
</a>
|
||||
<ol>
|
||||
<li>Create empty directory</li>
|
||||
<li>Run <code>npm init -y</code> or <code>yarn init -y</code></li>
|
||||
<li>Add the CommandBot package</li>
|
||||
</ol>
|
||||
<pre><code class="language-javascript"><span class="hl-0">// npm</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-1">install</span><span class="hl-2"> </span><span class="hl-1">commandbot</span><span class="hl-2">@</span><span class="hl-1">latest</span><br/><br/><span class="hl-0">// yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-1">add</span><span class="hl-2"> </span><span class="hl-1">commandbot</span><span class="hl-2">@</span><span class="hl-1">latest</span>
|
||||
</code></pre>
|
||||
<ol start="4">
|
||||
<li>Create <em>index.js/index.ts</em> file (TypeScript is a recommended language)</li>
|
||||
<li>Import the CommandBot package</li>
|
||||
</ol>
|
||||
<pre><code class="language-javascript"><span class="hl-0">// CommonJS</span><br/><span class="hl-3">const</span><span class="hl-2"> { </span><span class="hl-4">Bot</span><span class="hl-2"> } = </span><span class="hl-5">require</span><span class="hl-2">(</span><span class="hl-6">"commandbot"</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// ES Modules (to use ESM add "type": "module" to package.json file)</span><br/><span class="hl-7">import</span><span class="hl-2"> { </span><span class="hl-1">Bot</span><span class="hl-2"> } </span><span class="hl-7">from</span><span class="hl-2"> </span><span class="hl-6">"commandbot"</span><span class="hl-2">;</span>
|
||||
</code></pre>
|
||||
<ol start="6">
|
||||
<li>Initialize the bot instance (<a href="https://grz4na.github.io/commandbot/interfaces/InitOptions.html">InitOptions</a>) (list of available intents <a href="https://discord.js.org/#/docs/main/stable/class/Intents?scrollTo=s-FLAGS">here</a>)</li>
|
||||
</ol>
|
||||
<pre><code class="language-javascript"><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">bot</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-5">Bot</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"YOUR_BOT_NAME"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">globalPrefix:</span><span class="hl-2"> </span><span class="hl-6">"!"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">argumentSeparator:</span><span class="hl-2"> </span><span class="hl-6">","</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">commandSeparator:</span><span class="hl-2"> </span><span class="hl-6">"/"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">clientOptions:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-1">intents:</span><span class="hl-2"> [...</span><span class="hl-6">"DISCORD_API_INTENTS"</span><span class="hl-2">],</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-1">token:</span><span class="hl-2"> </span><span class="hl-6">"DISCORD_BOT_TOKEN"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">applicationId:</span><span class="hl-2"> </span><span class="hl-6">"APPLICATION_ID"</span><span class="hl-2">,</span><br/><span class="hl-2">});</span>
|
||||
</code></pre>
|
||||
<ol start="7">
|
||||
<li>Create and add commands to the <em>Bot</em> instance (see <a href="#commands">Commands</a>)</li>
|
||||
<li>Start your bot</li>
|
||||
</ol>
|
||||
<pre><code class="language-javascript"><span class="hl-1">bot</span><span class="hl-2">.</span><span class="hl-5">start</span><span class="hl-2">(</span><br/><span class="hl-2"> </span><span class="hl-1">port</span><span class="hl-2">, </span><span class="hl-0">// If passed, the application will create a HTTP server [type: number (integer)]</span><br/><span class="hl-2"> </span><span class="hl-3">true</span><span class="hl-2"> </span><span class="hl-0">// If true or undefined, the app will register all slash commands in the Discord API [type: boolean]</span><br/><span class="hl-2">);</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p><strong>WARNING!</strong> All commands have to be added to the instance <strong>before starting the bot</strong>. Adding commands while the bot is running is not possible and can cause issues.</p>
|
||||
</blockquote>
|
||||
|
||||
<a href="#commands" id="commands" style="color: inherit; text-decoration: none;">
|
||||
<h1>Commands</h1>
|
||||
</a>
|
||||
|
||||
<a href="#creating-a-command" id="creating-a-command" style="color: inherit; text-decoration: none;">
|
||||
<h2>Creating a command</h2>
|
||||
</a>
|
||||
<p>To create a command, use <em><a href="https://grz4na.github.io/commandbot/classes/CommandManager.html#add">CommandManager.prototype.add</a></em> method</p>
|
||||
<p>Command types</p>
|
||||
<ul>
|
||||
<li><a href="https://grz4na.github.io/commandbot/interfaces/ChatCommandInit.html">CHAT</a> - message interactions using command prefixes or slash commands</li>
|
||||
<li><a href="https://grz4na.github.io/commandbot/interfaces/ContextMenuCommandInit.html">USER</a> - right-click context menu interactions on users</li>
|
||||
<li><a href="https://grz4na.github.io/commandbot/interfaces/ContextMenuCommandInit.html">MESSAGE</a> - right-click context menu interactions on messages</li>
|
||||
</ul>
|
||||
<p>Chat command example:</p>
|
||||
<pre><code class="language-javascript"><span class="hl-1">bot</span><span class="hl-2">.</span><span class="hl-1">commands</span><span class="hl-2">.</span><span class="hl-5">add</span><span class="hl-2">(</span><span class="hl-6">"CHAT"</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"greet"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">parameters:</span><span class="hl-2"> [</span><br/><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"user"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"User to greet"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">optional:</span><span class="hl-2"> </span><span class="hl-3">false</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">type:</span><span class="hl-2"> </span><span class="hl-6">"user"</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> ],</span><br/><span class="hl-2"> </span><span class="hl-1">aliases:</span><span class="hl-2"> [</span><span class="hl-6">"hello"</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"Welcome someone to your server"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">usage:</span><span class="hl-2"> </span><span class="hl-6">"[user]"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">dm:</span><span class="hl-2"> </span><span class="hl-3">false</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">guilds:</span><span class="hl-2"> [</span><span class="hl-6">"123456789874561230"</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-1">slash:</span><span class="hl-2"> </span><span class="hl-3">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">visible:</span><span class="hl-2"> </span><span class="hl-3">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">permissions:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-1">resolvable:</span><span class="hl-2"> [</span><span class="hl-6">"ADMINISTRATOR"</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-1">checkType:</span><span class="hl-2"> </span><span class="hl-6">"ANY"</span><span class="hl-2">,</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-5">function</span><span class="hl-1">:</span><span class="hl-2"> </span><span class="hl-3">async</span><span class="hl-2"> (</span><span class="hl-1">i</span><span class="hl-2">) </span><span class="hl-3">=></span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">user</span><span class="hl-2"> = </span><span class="hl-7">await</span><span class="hl-2"> </span><span class="hl-1">i</span><span class="hl-2">.</span><span class="hl-5">get</span><span class="hl-2">(</span><span class="hl-6">"user"</span><span class="hl-2">).</span><span class="hl-5">toObject</span><span class="hl-2">();</span><br/><span class="hl-2"> </span><span class="hl-7">return</span><span class="hl-2"> </span><span class="hl-6">`Hello </span><span class="hl-3">${</span><span class="hl-1">user</span><span class="hl-8">.</span><span class="hl-5">toString</span><span class="hl-8">()</span><span class="hl-3">}</span><span class="hl-6">`</span><span class="hl-2">;</span><br/><span class="hl-2"> },</span><br/><span class="hl-2">});</span>
|
||||
</code></pre>
|
||||
<p>Command function schema is defined <strong><a href="https://grz4na.github.io/commandbot/modules.html#CommandFunction">here</a></strong></p>
|
||||
|
||||
<a href="#parameters" id="parameters" style="color: inherit; text-decoration: none;">
|
||||
<h2>Parameters</h2>
|
||||
</a>
|
||||
|
||||
<a href="#types" id="types" style="color: inherit; text-decoration: none;">
|
||||
<h3>Types</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li><a href="https://grz4na.github.io/commandbot/modules.html#ParameterType">primitive</a></li>
|
||||
<li><a href="https://grz4na.github.io/commandbot/modules.html#ObjectIdType">objects</a></li>
|
||||
</ul>
|
||||
<p>To get an entity ID from <em>ObjectID</em> use the <em><a href="https://grz4na.github.io/commandbot/classes/ObjectID.html#id">id</a></em> property. You can also call <em><a href="https://grz4na.github.io/commandbot/classes/ObjectID.html#toObject">toObject</a></em> method to retrieve full entity object from Discord API</p>
|
||||
|
||||
<a href="#defining" id="defining" style="color: inherit; text-decoration: none;">
|
||||
<h3>Defining</h3>
|
||||
</a>
|
||||
<p>Pass a list of <em><a href="https://grz4na.github.io/commandbot/interfaces/ParameterSchema.html">ParameterSchema</a></em> objects to <em><a href="https://grz4na.github.io/commandbot/interfaces/ChatCommandInit.html#parameters">parameters</a></em> property</p>
|
||||
<p>Example parameter object:</p>
|
||||
<pre><code class="language-javascript"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">: </span><span class="hl-6">"user"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-9">description</span><span class="hl-2">: </span><span class="hl-6">"User to mention"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-9">optional</span><span class="hl-2">: </span><span class="hl-3">false</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2">: </span><span class="hl-6">"user"</span><br/><span class="hl-2">}</span>
|
||||
</code></pre>
|
||||
|
||||
<a href="#reading-input-value" id="reading-input-value" style="color: inherit; text-decoration: none;">
|
||||
<h3>Reading input value</h3>
|
||||
</a>
|
||||
<p>To read parameter values use <em><a href="https://grz4na.github.io/commandbot/classes/InputManager.html#get">InputManager.prototype.get()</a></em> (passed in the first argument of a command function)</p>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-javascript"><span class="hl-3">function</span><span class="hl-2">: (</span><span class="hl-1">i</span><span class="hl-2">) </span><span class="hl-3">=></span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-10">const</span><span class="hl-2"> </span><span class="hl-1">userObj</span><span class="hl-2"> = </span><span class="hl-1">i</span><span class="hl-2">.</span><span class="hl-5">get</span><span class="hl-2">(</span><span class="hl-6">'member'</span><span class="hl-2">, </span><span class="hl-6">'user'</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><span class="hl-5">if</span><span class="hl-2">(</span><span class="hl-1">userObj</span><span class="hl-2">) {</span><br/><span class="hl-2"> </span><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">user</span><span class="hl-2"> = </span><span class="hl-1">userObj</span><span class="hl-2">.</span><span class="hl-5">toObject</span><span class="hl-2">();</span><br/><span class="hl-2"> </span><span class="hl-7">if</span><span class="hl-2">(</span><span class="hl-1">user</span><span class="hl-2">) {</span><br/><span class="hl-2"> </span><span class="hl-7">return</span><span class="hl-2"> </span><span class="hl-6">`Hello, </span><span class="hl-3">${</span><span class="hl-1">user</span><span class="hl-8">.</span><span class="hl-5">toString</span><span class="hl-8">()</span><span class="hl-3">}</span><span class="hl-6">`</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> </span><span class="hl-7">else</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">throw</span><span class="hl-2"> </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-10">Error</span><span class="hl-2">(</span><span class="hl-6">'User not found'</span><span class="hl-2">)</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
|
||||
</code></pre>
|
||||
|
||||
<a href="#events" id="events" style="color: inherit; text-decoration: none;">
|
||||
<h1>Events</h1>
|
||||
</a>
|
||||
<p>CommandBot is using <em><a href="https://nodejs.org/api/events.html">EventEmitter</a></em> that is built into Node.js. You can listen to events using the <em><a href="https://grz4na.github.io/commandbot/classes/Bot.html#on-1">on</a></em> method. Event types are available <strong><a href="https://grz4na.github.io/commandbot/classes/Bot.html#on-1">here</a></strong>.</p>
|
||||
|
||||
<a href="#messages" id="messages" style="color: inherit; text-decoration: none;">
|
||||
<h1>Messages</h1>
|
||||
</a>
|
||||
|
||||
<a href="#system-messages" id="system-messages" style="color: inherit; text-decoration: none;">
|
||||
<h2>System messages</h2>
|
||||
</a>
|
||||
<p>System messages can be composed and sent automatically when a certain action happens. All message types are available <strong><a href="">here</a></strong>. Their configuration is stored in <em><a href="https://grz4na.github.io/commandbot/classes/Bot.html#messages">Bot.prototype.messages.system</a></em> property. Each of these messages can be customized with <em><a href="https://github.com/GRZ4NA/CommandBot/issues/interfaces/SystemMessageAppearance.html">SystemMessageAppearance</a></em> objects. There is also a global <em><a href="https://grz4na.github.io/commandbot/classes/SystemMessageManager.html#deleteTimeout">deleteTimeout</a></em> property so messages can automatically be deleted after a given time.</p>
|
||||
|
||||
<a href="#help-message" id="help-message" style="color: inherit; text-decoration: none;">
|
||||
<h2>Help message</h2>
|
||||
</a>
|
||||
<p>Its configuration is stored in <em><a href="https://grz4na.github.io/commandbot/classes/Bot.html#messages">Bot.prototype.messages.help</a></em> property and can be customized with <em><a href="https://grz4na.github.io/commandbot/interfaces/HelpMessageParams.html">HelpMessageParams</a></em> object.</p>
|
||||
<blockquote>
|
||||
<p><strong>WARNING!</strong> You can't customize these messages after starting the bot. Changing these properties while the bot is running will have no effect.</p>
|
||||
</blockquote>
|
||||
|
||||
<a href="#issues" id="issues" style="color: inherit; text-decoration: none;">
|
||||
<h1>Issues</h1>
|
||||
</a>
|
||||
<p>Since this package is created by only 1 person it may contain some bugs or behave weirdly. If you notice any problem, typo etc, please create an issue in the <em><a href="https://github.com/GRZ4NA/CommandBot/issues">Issues</a></em> tab on GitHub.</p>
|
||||
<p>Thank you.</p>
|
||||
<p>Created with ❤️ by <a href="https://github.com/GRZ4NA">GRZANA</a></p>
|
||||
</div></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></liLine truncated
|
||||
@@ -0,0 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>APICommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="APICommandInit.html">APICommandInit</a></li></ul><h1>Interface APICommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Initialization options of core <a href="../classes/Command.html">Command</a> object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">APICommandInit</span><ul class="tsd-hierarchy"><li><a href="SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a></li><li><a href="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a></li></ul></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="APICommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandInit.html#name" class="tsd-kind-icon">name</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="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="APICommandInit.html" class="tsd-kind-icon">APICommand<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandInit.html#name" class="tsd-kind-icon">name</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>APICommandObject | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="APICommandObject.html">APICommandObject</a></li></ul><h1>Interface APICommandObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord base API command object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">APICommandObject</span><ul class="tsd-hierarchy"><li><a href="ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li><li><a href="ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></li><li><a href="SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></li></ul></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="APICommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandObject.html#name" class="tsd-kind-icon">name</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="default_permission" class="tsd-anchor"></a><h3>default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</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/aa6cb8b/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="APICommandObject.html" class="tsd-kind-icon">APICommand<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandObject.html#name" class="tsd-kind-icon">name</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,29 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ChatCommandInit.html">ChatCommandInit</a></li></ul><h1>Interface ChatCommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Intialization options of chat command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommandInit</span></li></ul></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="ChatCommandInit.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#visible" class="tsd-kind-icon">visible</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="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> aliases</h3><div class="tsd-signature tsd-kind-icon">aliases<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L104">src/commands/types/InitOptions.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Different string that can be used with prefix to invoke the command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L109">src/commands/types/InitOptions.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L81">src/commands/types/InitOptions.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be callable using private messages with bot</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (will be executed when calling a command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L86">src/commands/types/InitOptions.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Guild IDs in which the command can be called</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">?:</span> <a href="ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"simple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no_input"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L99">src/commands/types/InitOptions.ts:99</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of object defining all parameters of the command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">?:</span> <a href="CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L68">src/commands/types/InitOptions.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> slash</h3><div class="tsd-signature tsd-kind-icon">slash<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/commands/types/InitOptions.ts#L124">src/commands/types/InitOptions.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be registered as a slash command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> usage</h3><div class="tsd-signature tsd-kind-icon">usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L114">src/commands/types/InitOptions.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage (if <em>undefined</em>, the usage will be automatically generated using parameters)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> visible</h3><div class="tsd-signature tsd-kind-icon">visible<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/commands/types/InitOptions.ts#L119">src/commands/types/InitOptions.ts:119</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command is visible in the help message</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ChatCommandInit.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#visible" class="tsd-kind-icon">visible</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,13 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommandObject | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ChatCommandObject.html">ChatCommandObject</a></li></ul><h1>Interface ChatCommandObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord CHAT_INPUT command object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommandObject</span></li></ul></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 tsd-is-inherited"><a href="ChatCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L42">src/structures/types/api.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="options" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">?:</span> <a href="ChatCommandOptionObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandOptionObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L47">src/structures/types/api.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command options/parameters</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L37">src/structures/types/api.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command type (forced to 1)</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ChatCommandObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,16 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommandOptionObject | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ChatCommandOptionObject.html">ChatCommandOptionObject</a></li></ul><h1>Interface ChatCommandOptionObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord CHAT_INPUT command option object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ChatCommandOptionObject</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="ChatCommandOptionObject.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#required" class="tsd-kind-icon">required</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#type" class="tsd-kind-icon">type</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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">?:</span> <a href="TextCommandOptionChoiceObject.html" class="tsd-signature-type" data-tsd-kind="Interface">TextCommandOptionChoiceObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L81">src/structures/types/api.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of command option choices</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p><a href="ChatCommandOptionObject.html#type">type</a> must be set to <em>3</em> in order to implement choices</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L64">src/structures/types/api.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L59">src/structures/types/api.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="options" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">?:</span> <a href="ChatCommandOptionObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandOptionObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L86">src/structures/types/api.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord nested options/parameters</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="required" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> required</h3><div class="tsd-signature tsd-kind-icon">required<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/structures/types/api.ts#L74">src/structures/types/api.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is required to complete the request (command)\</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ChatCommandOptionType" class="tsd-signature-type" data-tsd-kind="Type alias">ChatCommandOptionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L69">src/structures/types/api.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter type</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ChatCommandOptionObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#required" class="tsd-kind-icon">required</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,3 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandPermission | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="CommandPermission.html">CommandPermission</a></li></ul><h1>Interface CommandPermission</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord permissions object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandPermission</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="CommandPermission.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#permission" class="tsd-kind-icon">permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#type" class="tsd-kind-icon">type</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="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L153">src/structures/types/api.ts:153</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="permission" class="tsd-anchor"></a><h3>permission</h3><div class="tsd-signature tsd-kind-icon">permission<span class="tsd-signature-symbol">:</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/aa6cb8b/src/structures/types/api.ts#L155">src/structures/types/api.ts:155</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandPermissionType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandPermissionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L154">src/structures/types/api.ts:154</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CommandPermission.html" class="tsd-kind-icon">Command<wbr/>Permission</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#permission" class="tsd-kind-icon">permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandPermissionsInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="CommandPermissionsInit.html">CommandPermissionsInit</a></li></ul><h1>Interface CommandPermissionsInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command permissions initialization object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandPermissionsInit</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="CommandPermissionsInit.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermissionsInit.html#resolvable" class="tsd-kind-icon">resolvable</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="checkType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Type<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#PermissionCheckTypes" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionCheckTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/permissions.ts#L33">src/commands/types/permissions.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to check if the caller has all defined permissions or at least one of them (applies only if the command uses Discord.js permission system)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="resolvable" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> resolvable</h3><div class="tsd-signature tsd-kind-icon">resolvable<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PermissionResolvable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PermissionFunction" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionFunction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/permissions.ts#L28">src/commands/types/permissions.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Resolvable (Discord.js permission resolvables) or custom function that returns <em>boolean</em> value</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CommandPermissionsInit.html" class="tsd-kind-icon">Command<wbr/>Permissions<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermissionsInit.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermissionsInit.html#resolvable" class="tsd-kind-icon">resolvable</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,19 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ContextMenuCommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ContextMenuCommandInit.html">ContextMenuCommandInit</a></li></ul><h1>Interface ContextMenuCommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Initialization options of context menu interactions</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">ContextMenuCommandInit</span></li></ul></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 tsd-is-inherited"><a href="ContextMenuCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandInit.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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> <a href="../modules.html#ContextType" class="tsd-signature-type" data-tsd-kind="Type alias">ContextType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L137">src/commands/types/InitOptions.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Context menu target type</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L81">src/commands/types/InitOptions.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be callable using private messages with bot</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (will be executed when calling a command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L86">src/commands/types/InitOptions.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Guild IDs in which the command can be called</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">?:</span> <a href="CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L68">src/commands/types/InitOptions.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ContextMenuCommandInit.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandInit.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ContextMenuCommandObject | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ContextMenuCommandObject.html">ContextMenuCommandObject</a></li></ul><h1>Interface ContextMenuCommandObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Context menu command object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">ContextMenuCommandObject</span></li></ul></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 tsd-is-inherited"><a href="ContextMenuCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L110">src/structures/types/api.ts:110</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ContextMenuCommandObject.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandObject.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>FunctionCommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="FunctionCommandInit.html">FunctionCommandInit</a></li></ul><h1>Interface FunctionCommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Initialization options of base executable command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><ul class="tsd-hierarchy"><li><span class="target">FunctionCommandInit</span><ul class="tsd-hierarchy"><li><a href="GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a></li><li><a href="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a></li></ul></li></ul></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="FunctionCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FunctionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FunctionCommandInit.html#name" class="tsd-kind-icon">name</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="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (will be executed when calling a command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="FunctionCommandInit.html" class="tsd-kind-icon">Function<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FunctionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FunctionCommandInit.html#name" class="tsd-kind-icon">name</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,15 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>GuildCommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="GuildCommandInit.html">GuildCommandInit</a></li></ul><h1>Interface GuildCommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Initialization options of base guild-scoped command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">GuildCommandInit</span></li></ul></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 tsd-is-inherited"><a href="GuildCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#name" class="tsd-kind-icon">name</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/commands/types/InitOptions.ts#L50">src/commands/types/InitOptions.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be callable using private messages with bot</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (will be executed when calling a command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L55">src/commands/types/InitOptions.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Guild IDs in which the command can be called</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="GuildCommandInit.html" class="tsd-kind-icon">Guild<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#name" class="tsd-kind-icon">name</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,17 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>HelpMessageParams | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="HelpMessageParams.html">HelpMessageParams</a></li></ul><h1>Interface HelpMessageParams</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>All properties used to customize the appearance of a help message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">HelpMessageParams</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="HelpMessageParams.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#color" class="tsd-kind-icon">color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#visible" class="tsd-kind-icon">visible</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="bottomText" class="tsd-anchor"></a><h3>bottom<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">bottom<wbr/>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/HelpMessage.ts#L24">src/commands/types/HelpMessage.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Text below the title</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="color" class="tsd-anchor"></a><h3>color</h3><div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ColorResolvable</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/HelpMessage.ts#L30">src/commands/types/HelpMessage.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Color of a message</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/HelpMessage.ts#L36">src/commands/types/HelpMessage.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Description of the "help" command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</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/aa6cb8b/src/commands/types/HelpMessage.ts#L12">src/commands/types/HelpMessage.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether help message is enabled</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="title" class="tsd-anchor"></a><h3>title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/HelpMessage.ts#L18">src/commands/types/HelpMessage.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Title field</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="usage" class="tsd-anchor"></a><h3>usage</h3><div class="tsd-signature tsd-kind-icon">usage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/HelpMessage.ts#L42">src/commands/types/HelpMessage.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Usage of the "help" command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="visible" class="tsd-anchor"></a><h3>visible</h3><div class="tsd-signature tsd-kind-icon">visible<span class="tsd-signature-symbol">:</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/aa6cb8b/src/commands/types/HelpMessage.ts#L48">src/commands/types/HelpMessage.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether the "help" command should be visible in the help message</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="HelpMessageParams.html" class="tsd-kind-icon">Help<wbr/>Message<wbr/>Params</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#color" class="tsd-kind-icon">color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#visible" class="tsd-kind-icon">visible</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,18 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>InitOptions | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="InitOptions.html">InitOptions</a></li></ul><h1>Interface InitOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Main object initialization options</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">InitOptions</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="InitOptions.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#clientOptions" class="tsd-kind-icon">client<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#token" class="tsd-kind-icon">token</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="applicationId" class="tsd-anchor"></a><h3>application<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">application<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Bot.ts#L50">src/structures/types/Bot.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API application ID</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="argumentSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> argument<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">argument<wbr/>Separator<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Bot.ts#L26">src/structures/types/Bot.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Separator used to split user input to a list of <a href="../classes/InputParameter.html">InputParameter</a>s (applies to prefix interactions)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="clientOptions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">client<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ClientOptions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Bot.ts#L38">src/structures/types/Bot.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Additional <a href="https://discord.js.org/#/docs/main/stable/typedef/ClientOptions">ClientOptions</a> for Discord.js <a href="https://discord.js.org/#/docs/main/stable/class/Client">Client</a> object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="commandSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> command<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">command<wbr/>Separator<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Bot.ts#L32">src/structures/types/Bot.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Separator used to split subcommands when using prefix interactions</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="globalPrefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> global<wbr/>Prefix</h3><div class="tsd-signature tsd-kind-icon">global<wbr/>Prefix<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Bot.ts#L20">src/structures/types/Bot.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Prefix used as a way to trigger the bot using messages in all guilds by default</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>If <em>undefined</em>, you can only interact with bot using slash commands or context menus</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Bot.ts#L12">src/structures/types/Bot.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Bot name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="token" class="tsd-anchor"></a><h3>token</h3><div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Bot.ts#L44">src/structures/types/Bot.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord bot token</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="InitOptions.html" class="tsd-kind-icon">Init<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#clientOptions" class="tsd-kind-icon">client<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#token" class="tsd-kind-icon">token</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,14 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ParameterSchema | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="ParameterSchema.html">ParameterSchema</a></li></ul><h1>Interface ParameterSchema</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Properties required to build a <a href="../classes/Parameter.html">Parameter</a> object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ParameterSchema</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="ParameterSchema.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#type" class="tsd-kind-icon">type</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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Parameter.ts#L73">src/structures/types/Parameter.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of value choices</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>Available only when type is set to "string"</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Parameter.ts#L54">src/structures/types/Parameter.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Parameter.ts#L48">src/structures/types/Parameter.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="optional" class="tsd-anchor"></a><h3>optional</h3><div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</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/aa6cb8b/src/structures/types/Parameter.ts#L60">src/structures/types/Parameter.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is optional</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/Parameter.ts#L66">src/structures/types/Parameter.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Type of parameter data</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ParameterSchema.html" class="tsd-kind-icon">Parameter<wbr/>Schema</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,13 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionCommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="PermissionCommandInit.html">PermissionCommandInit</a></li></ul><h1>Interface PermissionCommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Initialization options of base command with attached permissions</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">PermissionCommandInit</span><ul class="tsd-hierarchy"><li><a href="SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a></li><li><a href="PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a></li></ul></li></ul></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 tsd-is-inherited"><a href="PermissionCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (will be executed when calling a command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">?:</span> <a href="CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L68">src/commands/types/InitOptions.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="PermissionCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,17 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionGuildCommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a></li></ul><h1>Interface PermissionGuildCommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Initialization options of base guild-scoped command with attached permisisions</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">PermissionGuildCommandInit</span><ul class="tsd-hierarchy"><li><a href="ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a></li><li><a href="ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a></li></ul></li></ul></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 tsd-is-inherited"><a href="PermissionGuildCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/commands/types/InitOptions.ts#L81">src/commands/types/InitOptions.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be callable using private messages with bot</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (will be executed when calling a command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L86">src/commands/types/InitOptions.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Guild IDs in which the command can be called</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">?:</span> <a href="CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L68">src/commands/types/InitOptions.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="PermissionGuildCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,3 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>RegisteredCommandObject | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="RegisteredCommandObject.html">RegisteredCommandObject</a></li></ul><h1>Interface RegisteredCommandObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord registered command object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RegisteredCommandObject</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="RegisteredCommandObject.html#application_id" class="tsd-kind-icon">application_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#default_permissions" class="tsd-kind-icon">default_<wbr/>permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#guild_id" class="tsd-kind-icon">guild_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#version" class="tsd-kind-icon">version</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="application_id" class="tsd-anchor"></a><h3>application_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">application_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L135">src/structures/types/api.ts:135</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="default_permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permissions</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permissions<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/structures/types/api.ts#L140">src/structures/types/api.ts:140</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L138">src/structures/types/api.ts:138</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="guild_id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guild_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">guild_<wbr/>id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L136">src/structures/types/api.ts:136</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L133">src/structures/types/api.ts:133</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L137">src/structures/types/api.ts:137</a></li></ul></aside></section><section class="tsd-panel tsd-member Line truncated
|
||||
@@ -0,0 +1,9 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandGroupInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SubCommandGroupInit.html">SubCommandGroupInit</a></li></ul><h1>Interface SubCommandGroupInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Intialization options of subcommand group</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroupInit</span></li></ul></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 tsd-is-inherited"><a href="SubCommandGroupInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupInit.html#name" class="tsd-kind-icon">name</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L173">src/commands/types/InitOptions.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SubCommandGroupInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupInit.html#name" class="tsd-kind-icon">name</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandGroupObject | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SubCommandGroupObject.html">SubCommandGroupObject</a></li></ul><h1>Interface SubCommandGroupObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>API representation of subcommand group</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroupObject</span></li></ul></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 tsd-is-inherited"><a href="SubCommandGroupObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L125">src/structures/types/api.ts:125</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="options" class="tsd-anchor"></a><h3>options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L126">src/structures/types/api.ts:126</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L124">src/structures/types/api.ts:124</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SubCommandGroupObject.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,19 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandInit | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SubCommandInit.html">SubCommandInit</a></li></ul><h1>Interface SubCommandInit</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Subcommand initialization options</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandInit</span></li></ul></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 tsd-is-inherited"><a href="SubCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#usage" class="tsd-kind-icon">usage</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default permission</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L150">src/commands/types/InitOptions.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (will be executed when calling a command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">?:</span> <a href="ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"simple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no_input"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L155">src/commands/types/InitOptions.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of object defining all parameters of the command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">?:</span> <a href="CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L68">src/commands/types/InitOptions.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> usage</h3><div class="tsd-signature tsd-kind-icon">usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L160">src/commands/types/InitOptions.ts:160</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage (if <em>undefined</em>, the usage will be automatically generated using parameters)</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SubCommandInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#usage" class="tsd-kind-icon">usage</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,20 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SystemMessageAppearance | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SystemMessageAppearance.html">SystemMessageAppearance</a></li></ul><h1>Interface SystemMessageAppearance</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Configuration of a system message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SystemMessageAppearance</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="SystemMessageAppearance.html#accentColor" class="tsd-kind-icon">accent<wbr/>Color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#displayDetails" class="tsd-kind-icon">display<wbr/>Details</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#footer" class="tsd-kind-icon">footer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#showTimestamp" class="tsd-kind-icon">show<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#title" class="tsd-kind-icon">title</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="accentColor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> accent<wbr/>Color</h3><div class="tsd-signature tsd-kind-icon">accent<wbr/>Color<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ColorResolvable</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L38">src/structures/types/SystemMessage.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Color of a message</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="bottomText" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> bottom<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">bottom<wbr/>Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L32">src/structures/types/SystemMessage.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Text below the title</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="deleteTimeout" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> delete<wbr/>Timeout</h3><div class="tsd-signature tsd-kind-icon">delete<wbr/>Timeout<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L63">src/structures/types/SystemMessage.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Time (in ms) after a message of this type gets deleted</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>Set to <em>Infinity</em> to not delete the message</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="displayDetails" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr/>Details</h3><div class="tsd-signature tsd-kind-icon">display<wbr/>Details<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/structures/types/SystemMessage.ts#L44">src/structures/types/SystemMessage.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to display detailed informations in the message</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</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/aa6cb8b/src/structures/types/SystemMessage.ts#L20">src/structures/types/SystemMessage.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this type of message is enabled</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="footer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> footer</h3><div class="tsd-signature tsd-kind-icon">footer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L56">src/structures/types/SystemMessage.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Footer text</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="showTimestamp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> show<wbr/>Timestamp</h3><div class="tsd-signature tsd-kind-icon">show<wbr/>Timestamp<span class="tsd-signature-symbol">?:</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/aa6cb8b/src/structures/types/SystemMessage.ts#L50">src/structures/types/SystemMessage.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to show current time and date in a footer</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="title" class="tsd-anchor"></a><h3>title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L26">src/structures/types/SystemMessage.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Title field</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SystemMessageAppearance.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Appearance</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#accentColor" class="tsd-kind-icon">accent<wbr/>Color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#displayDetails" class="tsd-kind-icon">display<wbr/>Details</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#footer" class="tsd-kind-icon">footer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#showTimestamp" class="tsd-kind-icon">show<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#title" class="tsd-kind-icon">title</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SystemMessageData | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="SystemMessageData.html">SystemMessageData</a></li></ul><h1>Interface SystemMessageData</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>System message data definition</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SystemMessageData</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="SystemMessageData.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#phrase" class="tsd-kind-icon">phrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#user" class="tsd-kind-icon">user</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">?:</span> <a href="../classes/Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L75">src/structures/types/SystemMessage.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A <a href="../classes/Command.html">Command</a> instance</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="error" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3><div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><a href="../classes/PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L93">src/structures/types/SystemMessage.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Error object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="phrase" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> phrase</h3><div class="tsd-signature tsd-kind-icon">phrase<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L81">src/structures/types/SystemMessage.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Phrase received from a Discord channel</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="user" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> user</h3><div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">User</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/SystemMessage.ts#L87">src/structures/types/SystemMessage.ts:87</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>User who used the bot</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SystemMessageData.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Data</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#phrase" class="tsd-kind-icon">phrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#user" class="tsd-kind-icon">user</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,3 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TextCommandOptionChoiceObject | 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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">commandbot</a></li><li><a href="TextCommandOptionChoiceObject.html">TextCommandOptionChoiceObject</a></li></ul><h1>Interface TextCommandOptionChoiceObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord CHAT_INPUT command choice object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TextCommandOptionChoiceObject</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="TextCommandOptionChoiceObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#value" class="tsd-kind-icon">value</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="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L100">src/structures/types/api.ts:100</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="value" class="tsd-anchor"></a><h3>value</h3><div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/structures/types/api.ts#L101">src/structures/types/api.ts:101</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="TextCommandOptionChoiceObject.html" class="tsd-kind-icon">Text<wbr/>Command<wbr/>Option<wbr/>Choice<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#value" class="tsd-kind-icon">value</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-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>
|
||||
@@ -0,0 +1,83 @@
|
||||
<!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">TLine truncated
|
||||
<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">"BASE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FUNCTION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GUILD"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PERMISSION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PERMISSIONGUILD"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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<T><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">"BASE"</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">"FUNCTION"</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">"GUILD"</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">"PERMISSION"</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">"PERMISSIONGUILD"</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/aa6cb8b/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/aa6cb8b/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<T><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">"COMMAND"</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">"GROUP"</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/aa6cb8b/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/aa6cb8b/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">"COMMAND"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GROUP"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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<T><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">"COMMAND"</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">"GROUP"</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/aa6cb8b/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"> => </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/aa6cb8b/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'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"><</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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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<T><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">"CHAT"</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">"CONTEXT"</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/aa6cb8b/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">"ROLE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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">"CHAT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CONTEXT"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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<T><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">"CHAT"</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">"CONTEXT"</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/aa6cb8b/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">"USER"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"MESSAGE"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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<T><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">"string"</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">"boolean"</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">"number"</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">"user"</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"><</span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol">></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">"role"</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"><</span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol">></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">"channel"</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"><</span><span class="tsd-signature-type">"channel"</span><span class="tsd-signature-symbol">></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">"mentionable"</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"><</span><span class="tsd-signature-type">"mentionable"</span><span class="tsd-signature-symbol">></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/aa6cb8b/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">"PERMISSION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ERROR"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"NOT_FOUND"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"SUCCESS"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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<T><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">"channel"</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">"user"</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">"role"</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">"mentionable"</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/aa6cb8b/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">"user"</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">"channel"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mentionable"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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"><</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">null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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">"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="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/aa6cb8b/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">"ALL"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ANY"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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"> => </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/aa6cb8b/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/aa6cb8b/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<T><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">"USER"</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">"MESSAGE"</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/aa6cb8b/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">"MESSAGE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/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">ParLine truncated
|
||||
Reference in new issue
Block a user