docs/module-edbResponse.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: edbResponse</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: edbResponse</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">Formatação Padrão EDB para respostas de API.</div>
<dl class="details">
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li>v3.4.0</li></ul></dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li>v0.1.0</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Gabriel Bertola Bocca - gabriel at estudiodigitalbocca.com.br</li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>(c)2018-2021 Estúdio Digital Bocca - https://estudiodigitalbocca.com.br/</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line3">line 3</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~enviar"><span class="type-signature">(inner) </span>enviar<span class="signature">(req, res)</span><span class="type-signature"></span></h4>
<div class="description">
Envia a resposta da API.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>req</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Objeto de request do express.</td>
</tr>
<tr>
<td class="name"><code>res</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Objeto de response do express.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li>1.2.0</li></ul></dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li>0.1.0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~resposta"><span class="type-signature">(inner) </span>resposta<span class="signature">(st, ms, dd, req, res)</span><span class="type-signature"></span></h4>
<div class="description">
Recebe os dados da resposta.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>st</code></td>
<td class="type">
<span class="param-type">int</span>
</td>
<td class="description last">Status Code da resposta.</td>
</tr>
<tr>
<td class="name"><code>ms</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Título descritivo da resposta.</td>
</tr>
<tr>
<td class="name"><code>dd</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Objeto com os valores da resposta.</td>
</tr>
<tr>
<td class="name"><code>req</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Objeto de request do express.</td>
</tr>
<tr>
<td class="name"><code>res</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Objeto de response do express.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li>1.0.0</li></ul></dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li>0.1.0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-edbResponse.html">edbResponse</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Apr 30 2021 09:25:29 GMT-0300 (Horário Padrão de Brasília)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>