Skip to content

Commit bca541c

Browse files
author
neo-crypt
committed
fix docs
1 parent 2db588f commit bca541c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+24925
-1
lines changed

‎doc/api-jsdoc/Fetcher.html

Lines changed: 1128 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/api-jsdoc/Mailer.html

Lines changed: 1226 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/api-jsdoc/Slack.html

Lines changed: 379 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,379 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>JSDoc: Class: Slack</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: Slack</h1>
21+
22+
23+
24+
25+
26+
27+
<section>
28+
29+
<header>
30+
31+
<h2><span class="attribs"><span class="type-signature"></span></span>Slack<span class="signature">(options)</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="Slack"><span class="type-signature"></span>new Slack<span class="signature">(options)</span><span class="type-signature"></span></h4>
45+
46+
47+
48+
49+
50+
51+
<div class="description">
52+
Constructor
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>options</code></td>
89+
90+
91+
<td class="type">
92+
93+
94+
<span class="param-type">SlackOptions</span>
95+
96+
97+
98+
</td>
99+
100+
101+
102+
103+
104+
<td class="description last"></td>
105+
</tr>
106+
107+
108+
</tbody>
109+
</table>
110+
111+
112+
113+
114+
115+
116+
<dl class="details">
117+
118+
119+
120+
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+
131+
132+
133+
134+
135+
136+
137+
138+
139+
140+
141+
142+
143+
<dt class="tag-source">Source:</dt>
144+
<dd class="tag-source"><ul class="dummy"><li>
145+
<a href="lib_slack.js.html">lib/slack.js</a>, <a href="lib_slack.js.html#line12">line 12</a>
146+
</li></ul></dd>
147+
148+
149+
150+
151+
152+
153+
154+
</dl>
155+
156+
157+
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
</div>
175+
176+
177+
178+
179+
180+
181+
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
<h3 class="subsection-title">Methods</h3>
192+
193+
194+
195+
196+
197+
198+
199+
<h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(message, params)</span><span class="type-signature"></span></h4>
200+
201+
202+
203+
204+
205+
206+
<div class="description">
207+
Send message
208+
</div>
209+
210+
211+
212+
213+
214+
215+
216+
217+
218+
<h5>Parameters:</h5>
219+
220+
221+
<table class="params">
222+
<thead>
223+
<tr>
224+
225+
<th>Name</th>
226+
227+
228+
<th>Type</th>
229+
230+
231+
232+
233+
234+
<th class="last">Description</th>
235+
</tr>
236+
</thead>
237+
238+
<tbody>
239+
240+
241+
<tr>
242+
243+
<td class="name"><code>message</code></td>
244+
245+
246+
<td class="type">
247+
248+
249+
<span class="param-type">String</span>
250+
251+
252+
253+
</td>
254+
255+
256+
257+
258+
259+
<td class="description last">Message</td>
260+
</tr>
261+
262+
263+
264+
<tr>
265+
266+
<td class="name"><code>params</code></td>
267+
268+
269+
<td class="type">
270+
271+
272+
<span class="param-type">*</span>
273+
274+
275+
276+
</td>
277+
278+
279+
280+
281+
282+
<td class="description last">Slackbot params</td>
283+
</tr>
284+
285+
286+
</tbody>
287+
</table>
288+
289+
290+
291+
292+
293+
294+
<dl class="details">
295+
296+
297+
298+
299+
300+
301+
302+
303+
304+
305+
306+
307+
308+
309+
310+
311+
312+
313+
314+
315+
316+
317+
318+
319+
320+
321+
<dt class="tag-source">Source:</dt>
322+
<dd class="tag-source"><ul class="dummy"><li>
323+
<a href="lib_slack.js.html">lib/slack.js</a>, <a href="lib_slack.js.html#line31">line 31</a>
324+
</li></ul></dd>
325+
326+
327+
328+
329+
330+
331+
332+
</dl>
333+
334+
335+
336+
337+
338+
339+
340+
341+
342+
343+
344+
345+
346+
347+
348+
349+
350+
351+
352+
353+
354+
355+
356+
357+
</article>
358+
359+
</section>
360+
361+
362+
363+
364+
</div>
365+
366+
<nav>
367+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Fetcher.html">Fetcher</a></li><li><a href="Mailer.html">Mailer</a></li><li><a href="Slack.html">Slack</a></li><li><a href="Web3Client.html">Web3Client</a></li></ul><h3>Global</h3><ul><li><a href="global.html#actionSchema">actionSchema</a></li><li><a href="global.html#addAction">addAction</a></li><li><a href="global.html#addTicker">addTicker</a></li><li><a href="global.html#connect">connect</a></li><li><a href="global.html#createModel">createModel</a></li><li><a href="global.html#disconnect">disconnect</a></li><li><a href="global.html#exchangeSchema">exchangeSchema</a></li><li><a href="global.html#getActions">getActions</a></li><li><a href="global.html#getConnect">getConnect</a></li><li><a href="global.html#getDisconnect">getDisconnect</a></li><li><a href="global.html#getNodeExchangeOnOff">getNodeExchangeOnOff</a></li><li><a href="global.html#getNodeOnOff">getNodeOnOff</a></li><li><a href="global.html#getNodeState">getNodeState</a></li><li><a href="global.html#getNodeTickers">getNodeTickers</a></li><li><a href="global.html#getPing">getPing</a></li><li><a href="global.html#getPoolNotifications">getPoolNotifications</a></li><li><a href="global.html#getTickers">getTickers</a></li><li><a href="global.html#lightNodeStateSchema">lightNodeStateSchema</a></li><li><a href="global.html#masterNodeStateSchema">masterNodeStateSchema</a></li><li><a href="global.html#netNodeSchema">netNodeSchema</a></li><li><a href="global.html#nodeExchangeOnOff">nodeExchangeOnOff</a></li><li><a href="global.html#nodeOnOff">nodeOnOff</a></li><li><a href="global.html#nodeState">nodeState</a></li><li><a href="global.html#nodeTickers">nodeTickers</a></li><li><a href="global.html#notificationSchema">notificationSchema</a></li><li><a href="global.html#ping">ping</a></li><li><a href="global.html#poolNotifications">poolNotifications</a></li><li><a href="global.html#processNodesFinalAvarageRate">processNodesFinalAvarageRate</a></li><li><a href="global.html#processTickersAvarageRate">processTickersAvarageRate</a></li><li><a href="global.html#saveTickers">saveTickers</a></li><li><a href="global.html#tickerSchema">tickerSchema</a></li></ul>
368+
</nav>
369+
370+
<br class="clear">
371+
372+
<footer>
373+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 19 2018 04:53:01 GMT-0500 (EST)
374+
</footer>
375+
376+
<script> prettyPrint(); </script>
377+
<script src="scripts/linenumber.js"> </script>
378+
</body>
379+
</html>

0 commit comments

Comments
 (0)