Skip to content

Commit 330c0f8

Browse files
miguel-rrmiguel-rr
committed
Merge branch 'release/v0.3.0'
2 parents eda2b53 + 8ae3bc5 commit 330c0f8

File tree

67 files changed

+25490
-724
lines changed

Some content is hidden

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

67 files changed

+25490
-724
lines changed

‎docs/jsdocs/APIModule.html

Lines changed: 369 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,369 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
4+
<head>
5+
6+
<meta charset="utf-8">
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<title> APIModule</title>
9+
10+
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11+
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12+
<script src="./build/entry.js"></script>
13+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14+
<!--[if lt IE 9]>
15+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16+
<![endif]-->
17+
<link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18+
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19+
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20+
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
21+
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
22+
<link type="text/css" rel="stylesheet" href="">
23+
<script async defer src="https://buttons.github.io/buttons.js"></script>
24+
25+
26+
</head>
27+
28+
29+
30+
<body class="layout small-header">
31+
<div id="stickyNavbarOverlay"></div>
32+
33+
34+
<div class="top-nav">
35+
<div class="inner">
36+
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37+
<span aria-hidden="true"></span>
38+
<span aria-hidden="true"></span>
39+
<span aria-hidden="true"></span>
40+
</a>
41+
<div class="logo">
42+
43+
44+
</div>
45+
<div class="menu">
46+
47+
<div class="navigation">
48+
<a
49+
href="index.html"
50+
class="link"
51+
>
52+
API Documentation
53+
</a>
54+
<div class="dropdown is-hoverable is-right">
55+
<a class="dropdown-trigger link">
56+
Tutorials
57+
<i class="fas fa-chevron-down fa-xs"></i>
58+
</a>
59+
<div class="dropdown-menu">
60+
<div class="dropdown-content">
61+
62+
</div>
63+
</div>
64+
</div>
65+
66+
67+
</div>
68+
</div>
69+
</div>
70+
</div>
71+
<div id="main">
72+
<div
73+
class="sidebar "
74+
id="sidebarNav"
75+
>
76+
77+
<nav>
78+
79+
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="RuntimeValidator.html">RuntimeValidator</a></li></ul><h3>Interfaces</h3><ul><li><a href="ApiMethod.html">ApiMethod</a></li><li><a href="APIModule.html">APIModule</a></li><li><a href="ApiNamespace.html">ApiNamespace</a></li><li><a href="APIStructure.html">APIStructure</a></li><li><a href="DataProviderCall.html">DataProviderCall</a></li><li><a href="GroupedModelImports.html">GroupedModelImports</a></li><li><a href="JSDocContainer.html">JSDocContainer</a></li><li><a href="MethodCall.html">MethodCall</a></li><li><a href="ModelImport.html">ModelImport</a></li><li><a href="ModuleInfo.html">ModuleInfo</a></li><li><a href="Process.html">Process</a></li><li><a href="ProcessInfo.html">ProcessInfo</a></li><li><a href="ReturnTypeInfo.html">ReturnTypeInfo</a></li><li><a href="SocketCall.html">SocketCall</a></li><li><a href="SocketMessage.html">SocketMessage</a></li><li><a href="WatcherOptions.html">WatcherOptions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#activeWatchers">activeWatchers</a></li><li><a href="global.html#addProcessToQueue">addProcessToQueue</a></li><li><a href="global.html#apiPath">apiPath</a></li><li><a href="global.html#build">build</a></li><li><a href="global.html#capitalize">capitalize</a></li><li><a href="global.html#cleanText">cleanText</a></li><li><a href="global.html#copyContents">copyContents</a></li><li><a href="global.html#copyFile">copyFile</a></li><li><a href="global.html#defaultApiSourcePath">defaultApiSourcePath</a></li><li><a href="global.html#defaultModelSourcePath">defaultModelSourcePath</a></li><li><a href="global.html#defaultProxyTargetPath">defaultProxyTargetPath</a></li><li><a href="global.html#emptyFolder">emptyFolder</a></li><li><a href="global.html#ensureDir">ensureDir</a></li><li><a href="global.html#executeProcess">executeProcess</a></li><li><a href="global.html#exists">exists</a></li><li><a href="global.html#getData">getData</a></li><li><a href="global.html#getDocs">getDocs</a></li><li><a href="global.html#getExternalImports">getExternalImports</a></li><li><a href="global.html#getFilesRecursively">getFilesRecursively</a></li><li><a href="global.html#getInternalImports">getInternalImports</a></li><li><a href="global.html#getInternalModelImports">getInternalModelImports</a></li><li><a href="global.html#getModuleInfo">getModuleInfo</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#initWatchers">initWatchers</a></li><li><a href="global.html#isClient">isClient</a></li><li><a href="global.html#isJest">isJest</a></li><li><a href="global.html#method">method</a></li><li><a href="global.html#mkDir">mkDir</a></li><li><a href="global.html#modelPath">modelPath</a></li><li><a href="global.html#onApiValidation">onApiValidation</a></li><li><a href="global.html#onError">onError</a></li><li><a href="global.html#onModelValidation">onModelValidation</a></li><li><a href="global.html#proxyPath">proxyPath</a></li><li><a href="global.html#readDir">readDir</a></li><li><a href="global.html#readFile">readFile</a></li><li><a href="global.html#restart">restart</a></li><li><a href="global.html#rimraf">rimraf</a></li><li><a href="global.html#rmDir">rmDir</a></li><li><a href="global.html#setForceDisableJestDetection">setForceDisableJestDetection</a></li><li><a href="global.html#setForceServerSimulation">setForceServerSimulation</a></li><li><a href="global.html#socketPath">socketPath</a></li><li><a href="global.html#socketPort">socketPort</a></li><li><a href="global.html#start">start</a></li><li><a href="global.html#stop">stop</a></li><li><a href="global.html#targetPath">targetPath</a></li><li><a href="global.html#unlink">unlink</a></li><li><a href="global.html#watchFolder">watchFolder</a></li><li><a href="global.html#writeFile">writeFile</a></li></ul></div>
80+
81+
</nav>
82+
</div>
83+
<div class="core" id="main-content-wrapper">
84+
<div class="content">
85+
<header class="page-title">
86+
<p>Interface</p>
87+
<h1>APIModule</h1>
88+
</header>
89+
90+
91+
92+
93+
94+
<section>
95+
96+
<header>
97+
98+
<h2>APIModule</h2>
99+
100+
101+
</header>
102+
103+
<article>
104+
<div class="container-overview">
105+
106+
107+
<div class="description"><p>API module</p></div>
108+
109+
110+
111+
112+
113+
<dl class="details">
114+
115+
116+
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+
144+
145+
<p class="tag-source">
146+
<a href="model_api.ts.html" class="button">View Source</a>
147+
<span>
148+
<a href="model_api.ts.html">model/api.ts</a>, <a href="model_api.ts.html#line172">line 172</a>
149+
</span>
150+
</p>
151+
152+
</dl>
153+
154+
155+
156+
157+
</div>
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
<div class='vertical-section'>
173+
<h1>Members</h1>
174+
<div class="members">
175+
176+
<div class="member">
177+
178+
<span class="method-parameter is-pulled-right">
179+
<label>Type:</label>
180+
181+
<span class="param-type">function</span>
182+
183+
184+
</span>
185+
186+
<h4 class="name" id="default">
187+
<a class="href-link" href="#default">#</a>
188+
189+
<span class="code-name">
190+
default
191+
</span>
192+
193+
</h4>
194+
195+
196+
197+
198+
<div class="description">
199+
<p>Module default export. Must be a <code>function</code> and return a <code>Promise</code>. Should contain a method to be called from client</p>
200+
</div>
201+
202+
203+
204+
205+
206+
<dl class="details">
207+
208+
209+
210+
211+
212+
213+
214+
215+
216+
217+
218+
219+
220+
221+
222+
223+
224+
225+
226+
227+
228+
229+
230+
231+
232+
233+
234+
235+
236+
237+
238+
<p class="tag-source">
239+
<a href="model_api.ts.html" class="button">View Source</a>
240+
<span>
241+
<a href="model_api.ts.html">model/api.ts</a>, <a href="model_api.ts.html#line176">line 176</a>
242+
</span>
243+
</p>
244+
245+
</dl>
246+
247+
248+
249+
250+
251+
</div>
252+
253+
<div class="member">
254+
255+
<span class="method-parameter is-pulled-right">
256+
<label>Type:</label>
257+
258+
<span class="param-type">function</span>
259+
260+
261+
</span>
262+
263+
<h4 class="name" id="dispose">
264+
<a class="href-link" href="#dispose">#</a>
265+
266+
<span class="code-name">
267+
dispose
268+
</span>
269+
270+
<span class='tag'>Optional</span>
271+
272+
</h4>
273+
274+
275+
276+
277+
<div class="description">
278+
<p>Module dispose method. Optional. Will be called when a module is disposed or updated.</p>
279+
</div>
280+
281+
282+
283+
284+
285+
<dl class="details">
286+
287+
288+
289+
290+
291+
292+
293+
294+
295+
296+
297+
298+
299+
300+
301+
302+
303+
304+
305+
306+
307+
308+
309+
310+
311+
312+
313+
314+
315+
316+
317+
<p class="tag-source">
318+
<a href="model_api.ts.html" class="button">View Source</a>
319+
<span>
320+
<a href="model_api.ts.html">model/api.ts</a>, <a href="model_api.ts.html#line182">line 182</a>
321+
</span>
322+
</p>
323+
324+
</dl>
325+
326+
327+
328+
329+
330+
</div>
331+
332+
</div>
333+
</div>
334+
335+
336+
337+
338+
339+
340+
341+
</article>
342+
343+
</section>
344+
345+
346+
347+
348+
</div>
349+
350+
<footer class="footer">
351+
<div class="content has-text-centered">
352+
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a></p>
353+
<p class="sidebar-created-by">
354+
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
355+
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
356+
</p>
357+
</div>
358+
</footer>
359+
360+
</div>
361+
<div id="side-nav" class="side-nav">
362+
</div>
363+
</div>
364+
<script src="scripts/app.min.js"></script>
365+
<script>PR.prettyPrint();</script>
366+
<script src="scripts/linenumber.js"> </script>
367+
368+
</body>
369+
</html>

0 commit comments

Comments
 (0)