UNPKG

3.08 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: Command</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Class: Command</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2><span class="attribs"><span class="type-signature"></span></span>Command<span class="signature">(opts, run)</span><span class="type-signature"></span></h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43
44 <h4 class="name" id="Command"><span class="type-signature"></span>new Command<span class="signature">(opts, run)</span><span class="type-signature"></span></h4>
45
46
47
48
49
50
51<div class="description">
52 <p>Create a new command</p>
53</div>
54
55
56
57
58
59
60
61
62
63 <h5>Parameters:</h5>
64
65
66<table class="params">
67 <thead>
68 <tr>
69
70 <th>Name</th>
71
72
73 <th>Type</th>
74
75
76
77
78
79 <th class="last">Description</th>
80 </tr>
81 </thead>
82
83 <tbody>
84
85
86 <tr>
87
88 <td class="name"><code>opts</code></td>
89
90
91 <td class="type">
92
93
94<span class="param-type">CommandOptions</span>
95
96
97
98 </td>
99
100
101
102
103
104 <td class="description last"><p>Parameters for the command</p></td>
105 </tr>
106
107
108
109 <tr>
110
111 <td class="name"><code>run</code></td>
112
113
114 <td class="type">
115
116
117<span class="param-type">CommandCallback</span>
118
119
120
121 </td>
122
123
124
125
126
127 <td class="description last"><p>The actual function to run when the command is called</p></td>
128 </tr>
129
130
131 </tbody>
132</table>
133
134
135
136
137
138
139<dl class="details">
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166 <dt class="tag-source">Source:</dt>
167 <dd class="tag-source"><ul class="dummy"><li>
168 <a href="Command.js.html">Command.js</a>, <a href="Command.js.html#line11">line 11</a>
169 </li></ul></dd>
170
171
172
173
174
175
176
177</dl>
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199 </div>
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220</article>
221
222</section>
223
224
225
226
227</div>
228
229<nav>
230 <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Command.html">Command</a></li><li><a href="Handler.html">Handler</a></li></ul>
231</nav>
232
233<br class="clear">
234
235<footer>
236 Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Thu Jun 03 2021 13:46:08 GMT+0200 (Central European Summer Time)
237</footer>
238
239<script> prettyPrint(); </script>
240<script src="scripts/linenumber.js"> </script>
241</body>
242</html>
\No newline at end of file