| 1 | <!doctype html>
|
| 2 | <html>
|
| 3 |
|
| 4 | <head>
|
| 5 | <meta name="generator" content="JSDoc 3.6.2">
|
| 6 | <meta charset="utf-8">
|
| 7 | <title>keyu 2.0.0 » Module: io</title>
|
| 8 | <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
|
| 9 | <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
|
| 10 | <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
|
| 11 | <link href="css/baseline.css" rel="stylesheet">
|
| 12 | </head>
|
| 13 |
|
| 14 | <body onload="prettyPrint()">
|
| 15 | <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
|
| 16 | <div id="jsdoc-navbar-container">
|
| 17 | <div id="jsdoc-navbar-content">
|
| 18 | <a href="index.html" class="jsdoc-navbar-package-name">keyu 2.<wbr>0.<wbr>0</a>
|
| 19 | </div>
|
| 20 | </div>
|
| 21 | </nav>
|
| 22 | <div id="jsdoc-body-container">
|
| 23 | <div id="jsdoc-content">
|
| 24 | <div id="jsdoc-content-container">
|
| 25 | <div id="jsdoc-main" role="main">
|
| 26 | <header class="page-header">
|
| 27 | <div class="symbol-detail-labels"><span class="label label-kind">module</span></div>
|
| 28 | <h1><small></small><span class="symbol-name">io</span></h1>
|
| 29 | <p class="source-link">Source: <a href="io_index.js.html#source-line-2">io/<wbr>index.<wbr>js:2</a></p>
|
| 30 | <div class="symbol-description">
|
| 31 | </div>
|
| 32 | <dl class="dl-compact">
|
| 33 | </dl>
|
| 34 | </header>
|
| 35 | <section id="summary">
|
| 36 | <div class="summary-callout">
|
| 37 | <h2 class="summary-callout-heading">Method</h2>
|
| 38 | <div class="summary-content">
|
| 39 | <div class="summary-column">
|
| 40 | <dl class="dl-summary-callout">
|
| 41 | <dt><a href="module-io.html#~envOr">envOr(key, defaultValue, postProcessor, env)</a></dt>
|
| 42 | <dd>
|
| 43 | </dd>
|
| 44 | </dl>
|
| 45 | </div>
|
| 46 | <div class="summary-column">
|
| 47 | </div>
|
| 48 | <div class="summary-column">
|
| 49 | </div>
|
| 50 | </div>
|
| 51 | </div>
|
| 52 | </section>
|
| 53 | <section>
|
| 54 | <h2>Method</h2>
|
| 55 | <section>
|
| 56 | <div class="symbol-detail-labels"><span class="label label-inner">inner</span></div>
|
| 57 | <h3 id="~envOr"><span class="symbol-name">envOr</span><span class="signature"><span class="signature-params">(key, defaultValue, postProcessor, env)</span> → <span class="signature-returns"> any type</span></span></h3>
|
| 58 | <p>Returns and parses an environment var and if does not exists returns the default value</p>
|
| 59 | <section>
|
| 60 | <h4>Parameters</h4>
|
| 61 | <table class="jsdoc-details-table">
|
| 62 | <thead>
|
| 63 | <tr>
|
| 64 | <th>Name</th>
|
| 65 | <th>Type</th>
|
| 66 | <th>Optional</th>
|
| 67 | <th>Description</th>
|
| 68 | </tr>
|
| 69 | </thead>
|
| 70 | <tbody>
|
| 71 | <tr>
|
| 72 | <td>
|
| 73 | <p>key</p>
|
| 74 | </td>
|
| 75 | <td>
|
| 76 | <p>String</p>
|
| 77 | </td>
|
| 78 | <td>
|
| 79 | <p> </p>
|
| 80 | </td>
|
| 81 | <td>
|
| 82 | <p>key to get from our environment variables</p>
|
| 83 | </td>
|
| 84 | </tr>
|
| 85 | <tr>
|
| 86 | <td>
|
| 87 | <p>defaultValue</p>
|
| 88 | </td>
|
| 89 | <td>
|
| 90 | <p>any type</p>
|
| 91 | </td>
|
| 92 | <td>
|
| 93 | <p> </p>
|
| 94 | </td>
|
| 95 | <td>
|
| 96 | <p>default value to be returned if key not found</p>
|
| 97 | </td>
|
| 98 | </tr>
|
| 99 | <tr>
|
| 100 | <td>
|
| 101 | <p>postProcessor</p>
|
| 102 | </td>
|
| 103 | <td>
|
| 104 | <p>function()</p>
|
| 105 | </td>
|
| 106 | <td>
|
| 107 | <p> </p>
|
| 108 | </td>
|
| 109 | <td>
|
| 110 | <p>process the value once getted.</p>
|
| 111 | </td>
|
| 112 | </tr>
|
| 113 | <tr>
|
| 114 | <td>
|
| 115 | <p>env</p>
|
| 116 | </td>
|
| 117 | <td>
|
| 118 | <p>Object</p>
|
| 119 | </td>
|
| 120 | <td>
|
| 121 | <p> </p>
|
| 122 | </td>
|
| 123 | <td>
|
| 124 | <p>io source to read environment vars from</p>
|
| 125 | </td>
|
| 126 | </tr>
|
| 127 | </tbody>
|
| 128 | </table>
|
| 129 | </section>
|
| 130 | <dl class="dl-compact">
|
| 131 | <dt>Returns</dt>
|
| 132 | <dd>
|
| 133 | <p><code>any type</code> </p>
|
| 134 | </dd>
|
| 135 | </dl>
|
| 136 | </section>
|
| 137 | </section>
|
| 138 | </div>
|
| 139 | </div>
|
| 140 | <nav id="jsdoc-toc-nav" role="navigation"></nav>
|
| 141 | </div>
|
| 142 | </div>
|
| 143 | <footer id="jsdoc-footer" class="jsdoc-footer">
|
| 144 | <div id="jsdoc-footer-container">
|
| 145 | <p>
|
| 146 | Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.2 on June 17, 2019.
|
| 147 | </p>
|
| 148 | </div>
|
| 149 | </footer>
|
| 150 | <script src="scripts/jquery.min.js"></script>
|
| 151 | <script src="scripts/jquery.cookie.js"></script>
|
| 152 | <script src="scripts/tree.jquery.js"></script>
|
| 153 | <script src="scripts/prettify.js"></script>
|
| 154 | <script src="scripts/jsdoc-toc.js"></script>
|
| 155 | <script src="scripts/linenumber.js"></script>
|
| 156 | <script src="scripts/scrollanchor.js"></script>
|
| 157 | </body>
|
| 158 |
|
| 159 | </html> |
| \ | No newline at end of file |