docs: updated docs

Author: CMCDragonkai

README.md

@@ -40,6 +40,26 @@ See the docs at: https://matrixai.github.io/js-logger/
 
 ### Publishing
 
+Publishing is handled automatically by the staging pipeline.
+
+Prerelease:
+
+```sh
+# npm login
+npm version prepatch --preid alpha # premajor/preminor/prepatch
+git push --follow-tags
+```
+
+Release:
+
+```sh
+# npm login
+npm version patch # major/minor/patch
+git push --follow-tags
+```
+
+Manually:
+
 ```sh
 # npm login
 npm version patch # major/minor/patch

docs/assets/search.js

@@ -29,6 +29,14 @@ <h3>Docs Generation</h3>
 <a href="#publishing" id="publishing" style="color: inherit; text-decoration: none;">
   <h3>Publishing</h3>
 </a>
+<p>Publishing is handled automatically by the staging pipeline.</p>
+<p>Prerelease:</p>
+<pre><code class="language-sh"><span class="hl-1"># npm login</span><br/><span class="hl-0">npm version prepatch --preid alpha </span><span class="hl-1"># premajor/preminor/prepatch</span><br/><span class="hl-0">git push --follow-tags</span>
+</code></pre>
+<p>Release:</p>
+<pre><code class="language-sh"><span class="hl-1"># npm login</span><br/><span class="hl-0">npm version patch </span><span class="hl-1"># major/minor/patch</span><br/><span class="hl-0">git push --follow-tags</span>
+</code></pre>
+<p>Manually:</p>
 <pre><code class="language-sh"><span class="hl-1"># npm login</span><br/><span class="hl-0">npm version patch </span><span class="hl-1"># major/minor/patch</span><br/><span class="hl-0">npm run build</span><br/><span class="hl-0">npm publish --access public</span><br/><span class="hl-0">git push</span><br/><span class="hl-0">git push --tags</span>
 </code></pre>
-</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/formatting.html">formatting</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/LogLevel.html" class="tsd-kind-icon">Log<wbr/>Level</a></li><li class="tsd-kind-class"><a href="classes/ConsoleErrHandler.html" class="tsd-kind-icon">Console<wbr/>Err<wbr/>Handler</a></li><li class="tsd-kind-class"><a href="classes/ConsoleOutHandler.html" class="tsd-kind-icon">Console<wbr/>Out<wbr/>Handler</a></li><li class="tsd-kind-class"><a href="classes/Handler.html" class="tsd-kind-icon">Handler</a></li><li class="tsd-kind-class"><a href="classes/StreamHandler.html" class="tsd-kind-icon">Stream<wbr/>Handler</a></li><li class="tsd-kind-class"><a href="classes/default.html" class="tsd-kind-icon">default</a></li><li class="tsd-kind-interface"><a href="interfaces/ToString.html" class="tsd-kind-icon">To<wbr/>String</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LogFormatter" class="tsd-kind-icon">Log<wbr/>Formatter</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LogRecord" class="tsd-kind-icon">Log<wbr/>Record</a></li><li class="tsd-kind-function"><a href="modules.html#levelToString" class="tsd-kind-icon">level<wbr/>To<wbr/>String</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
+</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/formatting.html">formatting</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/LogLevel.html" class="tsd-kind-icon">Log<wbr/>Level</a></li><li class="tsd-kind-class"><a href="classes/ConsoleErrHandler.html" class="tsd-kind-icon">Console<wbr/>Err<wbr/>Handler</a></li><li class="tsd-kind-class"><a href="classes/ConsoleOutHandler.html" class="tsd-kind-icon">Console<wbr/>Out<wbr/>Handler</a></li><li class="tsd-kind-class"><a href="classes/Handler.html" class="tsd-kind-icon">Handler</a></li><li class="tsd-kind-class"><a href="classes/StreamHandler.html" class="tsd-kind-icon">Stream<wbr/>Handler</a></li><li class="tsd-kind-class"><a href="classes/default.html" class="tsd-kind-icon">default</a></li><li class="tsd-kind-interface"><a href="interfaces/ToJSON.html" class="tsd-kind-icon">ToJSON</a></li><li class="tsd-kind-interface"><a href="interfaces/ToString.html" class="tsd-kind-icon">To<wbr/>String</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LogData" class="tsd-kind-icon">Log<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LogDataKey" class="tsd-kind-icon">Log<wbr/>Data<wbr/>Key</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LogDataValue" class="tsd-kind-icon">Log<wbr/>Data<wbr/>Value</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LogFormatter" class="tsd-kind-icon">Log<wbr/>Formatter</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LogRecord" class="tsd-kind-icon">Log<wbr/>Record</a></li><li class="tsd-kind-variable"><a href="modules.html#hasCaptureStackTrace" class="tsd-kind-icon">has<wbr/>Capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-variable"><a href="modules.html#hasStackTraceLimit" class="tsd-kind-icon">has<wbr/>Stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-function"><a href="modules.html#evalLogData" class="tsd-kind-icon">eval<wbr/>Log<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#evalLogDataValue" class="tsd-kind-icon">eval<wbr/>Log<wbr/>Data<wbr/>Value</a></li><li class="tsd-kind-function"><a href="modules.html#levelToString" class="tsd-kind-icon">level<wbr/>To<wbr/>String</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>

docs/classes/default.html

@@ -0,0 +1 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ToJSON | @matrixai/logger</title><meta name="description" content="Documentation for @matrixai/logger"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@matrixai/logger</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@matrixai/logger</a></li><li><a href="ToJSON.html">ToJSON</a></li></ul><h1>Interface ToJSON </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ToJSON</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ToJSON.html#toJSON" class="tsd-kind-icon">toJSON</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link">toJSON<a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MatrixAI/js-logger/blob/master/src/types.ts#L16">types.ts:16</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> key: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/formatting.html">formatting</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ToJSON.html" class="tsd-kind-icon">ToJSON</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ToJSON.html#toJSON" class="tsd-kind-icon">toJSON</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>