docs/index.js.html from digitalbocca/edb-response

docs/index.js.html
Summary

Maintainability

Test Coverage

Issues
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: index.js</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">Source: index.js</h1>

    



    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>'use strict'

/**
 * Estúdio Digital Bocca - edb-response
 *
 * @module edbResponse
 * @description Formatação Padrão EDB para respostas de API.
 * @since v0.1.0
 *
 * @copyright (c)2018-2021 Estúdio Digital Bocca - https://estudiodigitalbocca.com.br/
 * @author Gabriel Bertola Bocca - gabriel at estudiodigitalbocca.com.br
 *
 * @version v3.4.0
 */

const edbResponse = {
  /**
   * Envia a resposta da API.
   *
   * @function enviar
   *
   * @param {object} req - Objeto de request do express.
   * @param {object} res - Objeto de response do express.
   *
   * @version 1.2.0
   * @since 0.1.0
   */
  enviar (req, res) {
    const resposta = req.edb.config
    res.status(resposta.status).json({
      status: resposta.status,
      msg: resposta.msg,
      dados: resposta.dados,
      apiVersion: process.env.VER,
      backend: process.env.BACK,
      copyright: '(c)2021 Estúdio Digital Bocca'
    })
  },

  /**
   * Recebe os dados da resposta.
   *
   * @function resposta
   *
   * @param {int} st - Status Code da resposta.
   * @param {string} ms - Título descritivo da resposta.
   * @param {object} dd - Objeto com os valores da resposta.
   * @param {object} req - Objeto de request do express.
   * @param {object} res - Objeto de response do express.
   *
   * @version 1.0.0
   * @since 0.1.0
   */
  resposta (st, ms, dd, req, res) {
    req.edb = {}
    req.edb.config = { status: st, msg: ms, dados: dd }
    this.enviar(req, res)
  }
}
module.exports = edbResponse
</code></pre>
        </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>