Skip to content

Commit

Permalink
Updated tests and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@igoramadas
igoramadas committed Apr 17, 2019
1 parent e04c4e1 commit 6a62320
Show file tree
Hide file tree
Showing 21 changed files with 1,441 additions and 1,094 deletions.
1 change: 0 additions & 1 deletion .gitignore
View file
Expand Up @@ -2,6 +2,5 @@
.history/
.vscode/
coverage/
lib/
node_modules/
npm-debug.log
2 changes: 1 addition & 1 deletion .travis.yml
View file
@@ -1,7 +1,7 @@
sudo: false
language: node_js
node_js:
- "11.13"
- "11.14"
- "10.15"
after_success:
- "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls"
1 change: 1 addition & 0 deletions Makefile
View file
Expand Up @@ -39,6 +39,7 @@ update:
npm link jaul
npm link anyhow
npm link setmeup
tsc

.PHONY: test
.PHONY: docs
4 changes: 2 additions & 2 deletions README.md
View file
@@ -1,7 +1,7 @@
# Expresser

[![Build Status](https://img.shields.io/travis/igoramadas/expresser.svg?style=flat-square)](https://travis-ci.org/igoramadas/expresser)
[![Coverage Status](https://img.shields.io/coveralls/github/igoramadas/expresser.svg?style=flat-square)](https://coveralls.io/github/igoramadas/expresser?branch=master)
[![Build Status](https://img.shields.io/travis/igoramadas/expresser.svg)](https://travis-ci.org/igoramadas/expresser)
[![Coverage Status](https://img.shields.io/coveralls/github/igoramadas/expresser.svg)](https://coveralls.io/github/igoramadas/expresser?branch=master)

A Node.js framework built on top of Express.

Expand Down
58 changes: 33 additions & 25 deletions docs/classes/_app_.app.html
View file
Expand Up @@ -137,7 +137,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L43">app.ts:43</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L43">app.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -158,7 +158,7 @@ <h3>events</h3>
<div class="tsd-signature tsd-kind-icon">events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"> =&nbsp;new EventEmitter()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L67">app.ts:67</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L70">app.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -173,7 +173,7 @@ <h3>express<wbr>App</h3>
<div class="tsd-signature tsd-kind-icon">express<wbr>App<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">express.Application</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L61">app.ts:61</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L64">app.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -188,7 +188,7 @@ <h3>server</h3>
<div class="tsd-signature tsd-kind-icon">server<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L64">app.ts:64</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L67">app.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -210,7 +210,7 @@ <h3>all</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L307">app.ts:307</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L311">app.ts:311</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -247,7 +247,7 @@ <h3>delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L357">app.ts:357</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L361">app.ts:361</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -284,7 +284,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L317">app.ts:317</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L321">app.ts:321</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -321,7 +321,7 @@ <h3>init</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L76">app.ts:76</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L79">app.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -352,7 +352,7 @@ <h3>kill</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L284">app.ts:284</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L287">app.ts:287</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -374,7 +374,7 @@ <h3>new<wbr>Instance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L41">app.ts:41</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L41">app.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -396,7 +396,7 @@ <h3>patch</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L347">app.ts:347</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L351">app.ts:351</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -433,7 +433,7 @@ <h3>post</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L327">app.ts:327</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L331">app.ts:331</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -470,7 +470,7 @@ <h3>put</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L337">app.ts:337</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L341">app.ts:341</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -507,7 +507,7 @@ <h3>render<wbr>Error</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L540">app.ts:540</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L552">app.ts:552</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -564,7 +564,7 @@ <h3>render<wbr>Image</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L507">app.ts:507</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L517">app.ts:517</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -621,7 +621,7 @@ <h3>render<wbr>Json</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L451">app.ts:451</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L459">app.ts:459</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -670,7 +670,7 @@ <h3>render<wbr>Text</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L422">app.ts:422</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L428">app.ts:428</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -719,7 +719,7 @@ <h3>render<wbr>View</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L392">app.ts:392</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L396">app.ts:396</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -732,25 +732,33 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<li>
<h5>req: <span class="tsd-signature-type">express.Request</span></h5>
<div class="tsd-comment tsd-typography">
<p>The Express request object.</p>
<div class="lead">
<p>The Express request object.</p>
</div>
</div>
</li>
<li>
<h5>res: <span class="tsd-signature-type">express.Response</span></h5>
<div class="tsd-comment tsd-typography">
<p>The Express response object.</p>
<div class="lead">
<p>The Express response object.</p>
</div>
</div>
</li>
<li>
<h5>view: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The view filename.</p>
<div class="lead">
<p>The view filename.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Options passed to the view, optional.</p>
<div class="lead">
<p>Options passed to the view, optional.</p>
</div>
</div>
</li>
</ul>
Expand All @@ -768,7 +776,7 @@ <h3>route</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L377">app.ts:377</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L381">app.ts:381</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -800,7 +808,7 @@ <h3>start</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L225">app.ts:225</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L228">app.ts:228</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -826,7 +834,7 @@ <h3>use</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L367">app.ts:367</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L371">app.ts:371</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/_logger_.logger.html
View file
Expand Up @@ -108,7 +108,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> args<wbr>Cleaner</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/logger.ts#L13">logger.ts:13</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/logger.ts#L13">logger.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -139,7 +139,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> clean</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/logger.ts#L82">logger.ts:82</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/logger.ts#L73">logger.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
View file
Expand Up @@ -63,8 +63,8 @@ <h1> Expresser</h1>
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="expresser">Expresser</h1>
<p><a href="https://travis-ci.org/igoramadas/expresser"><img src="https://img.shields.io/travis/igoramadas/expresser.svg?style=flat-square" alt="Build Status"></a>
<a href="https://coveralls.io/github/igoramadas/expresser?branch=master"><img src="https://img.shields.io/coveralls/github/igoramadas/expresser.svg?style=flat-square" alt="Coverage Status"></a></p>
<p><a href="https://travis-ci.org/igoramadas/expresser"><img src="https://img.shields.io/travis/igoramadas/expresser.svg" alt="Build Status"></a>
<a href="https://coveralls.io/github/igoramadas/expresser?branch=master"><img src="https://img.shields.io/coveralls/github/igoramadas/expresser.svg" alt="Coverage Status"></a></p>
<p>A Node.js framework built on top of Express.</p>
<h2 id="why-expresser-">Why Expresser?</h2>
<p>Building on top of Express with added logging, utilities and extra plugins. The idea of Expresser is to aggregate
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_app_.middlewaredefs.html
View file
Expand Up @@ -104,7 +104,7 @@ <h3>append</h3>
<div class="tsd-signature tsd-kind-icon">append<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L29">app.ts:29</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L29">app.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -119,7 +119,7 @@ <h3>prepend</h3>
<div class="tsd-signature tsd-kind-icon">prepend<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/app.ts#L27">app.ts:27</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/app.ts#L27">app.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/_index_.html
View file
Expand Up @@ -85,7 +85,7 @@ <h3><span class="tsd-flag ts-flagLet">Let</span> <span class="tsd-flag ts-flagEx
<div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/index.ts#L14">index.ts:14</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/index.ts#L14">index.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -99,7 +99,7 @@ <h3>app</h3>
<div class="tsd-signature tsd-kind-icon">app<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;require(&quot;./data&quot;)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/index.ts#L16">index.ts:16</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/index.ts#L16">index.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -114,7 +114,7 @@ <h3>version</h3>
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;version</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/217fa6e/src/index.ts#L18">index.ts:18</a></li>
<li>Defined in <a href="https://github.com/igoramadas/expresser/blob/e04c4e1/src/index.ts#L18">index.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down

0 comments on commit 6a62320

Please sign in to comment.