Skip to content

Commit

Permalink
Merge branch 'release/v0.3.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
@miguelBinpar
miguelBinpar committed May 14, 2020
2 parents eda2b53 + 8ae3bc5 commit 330c0f8
Show file tree
Hide file tree
Showing 67 changed files with 25,490 additions and 724 deletions.
369 changes: 369 additions & 0 deletions docs/jsdocs/APIModule.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,369 @@
<!DOCTYPE html>
<html lang="en">

<head>

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title> APIModule</title>

<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
<script src="./build/entry.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
<link type="text/css" rel="stylesheet" href="">
<script async defer src="https://buttons.github.io/buttons.js"></script>


</head>



<body class="layout small-header">
<div id="stickyNavbarOverlay"></div>


<div class="top-nav">
<div class="inner">
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
<div class="logo">


</div>
<div class="menu">

<div class="navigation">
<a
href="index.html"
class="link"
>
API Documentation
</a>
<div class="dropdown is-hoverable is-right">
<a class="dropdown-trigger link">
Tutorials
<i class="fas fa-chevron-down fa-xs"></i>
</a>
<div class="dropdown-menu">
<div class="dropdown-content">

</div>
</div>
</div>


</div>
</div>
</div>
</div>
<div id="main">
<div
class="sidebar "
id="sidebarNav"
>

<nav>

<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>

</nav>
</div>
<div class="core" id="main-content-wrapper">
<div class="content">
<header class="page-title">
<p>Interface</p>
<h1>APIModule</h1>
</header>





<section>

<header>

<h2>APIModule</h2>


</header>

<article>
<div class="container-overview">


<div class="description"><p>API module</p></div>





<dl class="details">































<p class="tag-source">
<a href="model_api.ts.html" class="button">View Source</a>
<span>
<a href="model_api.ts.html">model/api.ts</a>, <a href="model_api.ts.html#line172">line 172</a>
</span>
</p>

</dl>




</div>














<div class='vertical-section'>
<h1>Members</h1>
<div class="members">

<div class="member">

<span class="method-parameter is-pulled-right">
<label>Type:</label>

<span class="param-type">function</span>


</span>

<h4 class="name" id="default">
<a class="href-link" href="#default">#</a>

<span class="code-name">
default
</span>

</h4>




<div class="description">
<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>
</div>





<dl class="details">































<p class="tag-source">
<a href="model_api.ts.html" class="button">View Source</a>
<span>
<a href="model_api.ts.html">model/api.ts</a>, <a href="model_api.ts.html#line176">line 176</a>
</span>
</p>

</dl>





</div>

<div class="member">

<span class="method-parameter is-pulled-right">
<label>Type:</label>

<span class="param-type">function</span>


</span>

<h4 class="name" id="dispose">
<a class="href-link" href="#dispose">#</a>

<span class="code-name">
dispose
</span>

<span class='tag'>Optional</span>

</h4>




<div class="description">
<p>Module dispose method. Optional. Will be called when a module is disposed or updated.</p>
</div>





<dl class="details">































<p class="tag-source">
<a href="model_api.ts.html" class="button">View Source</a>
<span>
<a href="model_api.ts.html">model/api.ts</a>, <a href="model_api.ts.html#line182">line 182</a>
</span>
</p>

</dl>





</div>

</div>
</div>







</article>

</section>




</div>

<footer class="footer">
<div class="content has-text-centered">
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a></p>
<p class="sidebar-created-by">
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
</p>
</div>
</footer>

</div>
<div id="side-nav" class="side-nav">
</div>
</div>
<script src="scripts/app.min.js"></script>
<script>PR.prettyPrint();</script>
<script src="scripts/linenumber.js"> </script>

</body>
</html>
Loading

0 comments on commit 330c0f8

Please sign in to comment.