Skip to content

Commit

Permalink
restructure docs, add signature for .drone.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
@bdfoster
bdfoster committed Apr 4, 2017
1 parent a145baf commit c970fdc
Show file tree
Hide file tree
Showing 20 changed files with 113 additions and 518 deletions.
1 change: 1 addition & 0 deletions .drone.yml.sig
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
eyJhbGciOiJIUzI1NiJ9.cGlwZWxpbmU6CiAgYnVpbGQ6CiAgICB3aGVuOgogICAgICBldmVudDogW3RhZywgcHVzaCwgcHVsbF9yZXF1ZXN0XQogICAgaW1hZ2U6IG5vZGU6JHtOT0RFX1ZFUlNJT059ICAgICAgCiAgICBjb21tYW5kczoKICAgICAgLSBucG0gaW5zdGFsbAogICAgICAtIG5wbSB0ZXN0CiAgYW5hbHlzaXM6CiAgICB3aGVuOgogICAgICBzdGF0dXM6IHN1Y2Nlc3MKICAgICAgbWF0cml4OgogICAgICAgIE5PREVfVkVSU0lPTjogNgogICAgaW1hZ2U6IG5vZGU6JHtOT0RFX1ZFUlNJT059CiAgICBlbnZpcm9ubWVudDoKICAgICAgLSBDT1ZFUkFMTFNfU0VSVklDRV9OQU1FPSR7Q0l9CiAgICAgIC0gQ09WRVJBTExTX1NFUlZJQ0VfSk9CX0lEPSR7RFJPTkVfSk9CX05VTUJFUn0KICAgIGNvbW1hbmRzOgogICAgICAtIG5wbSBpbnN0YWxsIC1nIGNvdmVyYWxscwogICAgICAtIG5wbSBydW4gY292ZXJhbGxzCiAgcHVibGlzaDoKICAgIHdoZW46CiAgICAgIHN0YXR1czogc3VjY2VzcwogICAgICBldmVudDogdGFnCiAgICBjb21tYW5kczoKICAgICAgLSBucG0gcnVuIGNvbXBpbGUKICAgIAptYXRyaXg6CiAgTk9ERV9WRVJTSU9OOgogICAgLSA2CiAgICAtIDcK.ZrZYrF2qEMerDekQoABLd4fuZB0QmpOmwK3fisIS_HM
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

22 changes: 8 additions & 14 deletions docs/classes/console.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="transport.html">Transport</a>.<a href="transport.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/transport/Console.ts#L10">transport/Console.ts:10</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/transport/console.ts#L10">transport/console.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -146,7 +146,7 @@ <h3>level</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="transport.html">Transport</a>.<a href="transport.html#level">level</a></p>
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Transport.ts#L12">Transport.ts:12</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/transport/index.ts#L10">transport/index.ts:10</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3>template</h3>
<div class="tsd-signature tsd-kind-icon">template<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/transport/Console.ts#L10">transport/Console.ts:10</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/transport/console.ts#L10">transport/console.ts:10</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -216,20 +216,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a name="execute" class="tsd-anchor"></a>
<h3>execute</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>entry<span class="tsd-signature-symbol">: </span><a href="../interfaces/entry.html" class="tsd-signature-type">Entry</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>entry<span class="tsd-signature-symbol">: </span><a href="../interfaces/loggerentry.html" class="tsd-signature-type">LoggerEntry</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="transport.html">Transport</a>.<a href="transport.html#execute">execute</a></p>
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/transport/Console.ts#L18">transport/Console.ts:18</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/transport/console.ts#L18">transport/console.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>entry: <a href="../interfaces/entry.html" class="tsd-signature-type">Entry</a></h5>
<h5>entry: <a href="../interfaces/loggerentry.html" class="tsd-signature-type">LoggerEntry</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand Down Expand Up @@ -405,26 +405,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a href="../interfaces/consoleoptions.html" class="tsd-kind-icon">Console<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/entry.html" class="tsd-kind-icon">Entry</a>
<a href="../interfaces/levels.html" class="tsd-kind-icon">Levels</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/levels.html" class="tsd-kind-icon">Levels</a>
<a href="../interfaces/loggerentry.html" class="tsd-kind-icon">Logger<wbr>Entry</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/loggeroptions.html" class="tsd-kind-icon">Logger<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/transportoptions.html" class="tsd-kind-icon">Transport<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#transporthandler" class="tsd-kind-icon">Transport<wbr>Handler</a>
</li>
<li class=" tsd-kind-variable">
<a href="../globals.html#console" class="tsd-kind-icon">console</a>
</li>
<li class=" tsd-kind-variable">
<a href="../globals.html#transport" class="tsd-kind-icon">transport</a>
</li>
</ul>
</nav>
</div>
Expand Down
44 changes: 19 additions & 25 deletions docs/classes/logger.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides EventEmitter.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L110">Logger.ts:110</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L118">logger.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -177,7 +177,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> children</h3>
<div class="tsd-signature tsd-kind-icon">children<span class="tsd-signature-symbol">:</span> <a href="logger.html" class="tsd-signature-type">Logger</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L77">Logger.ts:77</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L85">logger.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -214,7 +214,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L82">Logger.ts:82</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L90">logger.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -229,12 +229,12 @@ <h3>template</h3>
<div class="tsd-signature tsd-kind-icon">template<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L110">Logger.ts:110</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L118">logger.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The template to be used when parsing <code>Entry.data</code> for an <code>Entry.message</code>.
<p>The template to be used when parsing <code>LoggerEntry.data</code> for an <code>LoggerEntry.message</code>.
When a log message is not defined, the data associated with it can be used to create the message.</p>
</div>
<p>For example:</p>
Expand All @@ -247,9 +247,9 @@ <h3>template</h3>
<span class="hljs-attr">length</span>: <span class="hljs-number">1203</span>
};
</code></pre>
<p>The <code>Entry</code> (sent on <code>execute</code> of each associated transport) would include a <code>message</code> property set to
<p>The <code>LoggerEntry</code> (sent on <code>execute</code> of each associated transport) would include a <code>message</code> property set to
<code>GET /api/v1/users?page=1 ==&gt; 200 1203 bytes</code>.</p>
<p>When defining a template, variables from the log entry&#39;s data object are used. The name of the variable should
<p>When defining a template, variables from the log LoggerEntry&#39;s data object are used. The name of the variable should
be contained within curly braces, i.e. &#39;{key}&#39; would be replaced with <code>value</code> if data has a property of <code>key</code> with
value of <code>value</code>.</p>
<p>By default, a template is not used, so a message must be specified when calling <code>log</code> (or a method associated with
Expand All @@ -263,7 +263,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> transports</h3>
<div class="tsd-signature tsd-kind-icon">transports<span class="tsd-signature-symbol">:</span> <a href="transport.html" class="tsd-signature-type">Transport</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L73">Logger.ts:73</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L81">logger.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -291,7 +291,7 @@ <h3>levels</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L133">Logger.ts:133</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L141">logger.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -304,7 +304,7 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/levels.html" class=
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L142">Logger.ts:142</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L150">logger.ts:150</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -340,7 +340,7 @@ <h3>configure</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L191">Logger.ts:191</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L199">logger.ts:199</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -369,7 +369,7 @@ <h3>create</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L218">Logger.ts:218</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L226">logger.ts:226</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -427,7 +427,7 @@ <h3>find</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L232">Logger.ts:232</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L240">logger.ts:240</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -450,7 +450,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L284">Logger.ts:284</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L292">logger.ts:292</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -479,7 +479,7 @@ <h3>log</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L250">Logger.ts:250</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L258">logger.ts:258</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -618,7 +618,7 @@ <h3>register</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L299">Logger.ts:299</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L307">logger.ts:307</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -647,7 +647,7 @@ <h3>use</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/ad7d663/src/Logger.ts#L316">Logger.ts:316</a></li>
<li>Defined in <a href="https://github.com/bdfoster/nomatic-logging/blob/a145baf/src/logger.ts#L324">logger.ts:324</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -758,26 +758,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a href="../interfaces/consoleoptions.html" class="tsd-kind-icon">Console<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/entry.html" class="tsd-kind-icon">Entry</a>
<a href="../interfaces/levels.html" class="tsd-kind-icon">Levels</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/levels.html" class="tsd-kind-icon">Levels</a>
<a href="../interfaces/loggerentry.html" class="tsd-kind-icon">Logger<wbr>Entry</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/loggeroptions.html" class="tsd-kind-icon">Logger<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/transportoptions.html" class="tsd-kind-icon">Transport<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#transporthandler" class="tsd-kind-icon">Transport<wbr>Handler</a>
</li>
<li class=" tsd-kind-variable">
<a href="../globals.html#console" class="tsd-kind-icon">console</a>
</li>
<li class=" tsd-kind-variable">
<a href="../globals.html#transport" class="tsd-kind-icon">transport</a>
</li>
</ul>
</nav>
</div>
Expand Down
Loading

0 comments on commit c970fdc

Please sign in to comment.