Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/FoxxMD/logging. A typed, opinionated, batteries-included, Pino-based logging solution for backend T foxxmd.github.io/logging
Something went wrong. Try again.
22 kB · 15 lines
HTML
at gh-pages
12345678910111213141516<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LogOptions | @foxxmd/logging Docs</title><meta name="description" content="Documentation for @foxxmd/logging Docs"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script defer data-domain="foxxmd.github.io" src="https://plausible.foxxmd.dev/js/script.js"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="http://foxxmd.github.io/logging">Docs</a><a href="https://github.com/foxxmd/logging">GitHub</a></div></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">@foxxmd/logging Docs</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@foxxmd/logging Docs</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.LogOptions.html">LogOptions</a></li></ul><h1>Interface LogOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Configure log levels and file options for an AppLogger.</p><pre><code class="ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">infoLogger</span><span class="hl-1"> = </span><span class="hl-6">loggerApp</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">level:</span><span class="hl-1"> </span><span class="hl-3">'info'</span><span class="hl-1"> </span><span class="hl-7">// console and file will log any levels `info` and above</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">logger</span><span class="hl-1"> = </span><span class="hl-6">loggerApp</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">console:</span><span class="hl-1"> </span><span class="hl-3">'debug'</span><span class="hl-1">, </span><span class="hl-7">// console will log `debug` and higher</span><br/><span class="hl-1"> </span><span class="hl-0">file:</span><span class="hl-1"> </span><span class="hl-3">'warn'</span><span class="hl-1"> </span><span class="hl-7">// file will log `warn` and higher</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">fileLogger</span><span class="hl-1"> = </span><span class="hl-6">loggerRollingApp</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">console:</span><span class="hl-1"> </span><span class="hl-3">'debug'</span><span class="hl-1">, </span><span class="hl-7">// console will log `debug` and higher</span><br/><span class="hl-1"> </span><span class="hl-0">file:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">level:</span><span class="hl-1"> </span><span class="hl-3">'warn'</span><span class="hl-1">, </span><span class="hl-7">// file will log `warn` and higher</span><br/><span class="hl-1"> </span><span class="hl-0">path:</span><span class="hl-1"> </span><span class="hl-3">'/my/cool/path/output.log'</span><span class="hl-1">, </span><span class="hl-7">// optionally, output to log file at this path</span><br/><span class="hl-1"> </span><span class="hl-0">frequency:</span><span class="hl-1"> </span><span class="hl-3">'hourly'</span><span class="hl-1">, </span><span class="hl-7">// optionally, rotate hourly</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span></code><button type="button">Copy</button></pre>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">LogOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="index.LogOptions.html#level">level</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"silent"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fatal"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"warn"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"info"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"log"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"verbose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"debug"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"trace"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="index.LogOptions.html#file">file</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">false</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"silent"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fatal"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"warn"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"info"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"log"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"verbose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"debug"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"trace"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="index.FileLogOptions.html" class="tsd-signature-type tsd-kind-interface">FileLogOptions</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="index.LogOptions.html#console">console</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"silent"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fatal"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"warn"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"info"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"log"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"verbose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"debug"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"trace"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/FoxxMD/logging/blob/53d273daf96985a00fc5276681a5e31900cc8ef3/src/types.ts#L89">src/types.ts:89</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="index.LogOptions.html#level" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>level?</span></a><a href="index.LogOptions.html#file" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file?</span></a><a href="index.LogOptions.html#console" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>console?</span></a></div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="level" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>level</span><a href="#level" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">level</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"silent"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fatal"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"warn"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"info"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"log"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"verbose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"debug"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"trace"</span></div><div class="tsd-comment tsd-typography"><p>Specify the minimum log level for all log outputs without their own level specified.</p><p>Defaults to env <code>LOG_LEVEL</code> or <code>info</code> if not specified.</p></div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Default" class="tsd-anchor"></a>Default<a href="#Default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">'info'</span></code><button type="button">Copy</button></pre>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/FoxxMD/logging/blob/53d273daf96985a00fc5276681a5e31900cc8ef3/src/types.ts#L97">src/types.ts:97</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="file" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>file</span><a href="#file" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">file</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">false</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"silent"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fatal"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"warn"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"info"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"log"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"verbose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"debug"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"trace"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="index.FileLogOptions.html" class="tsd-signature-type tsd-kind-interface">FileLogOptions</a></div><div class="tsd-comment tsd-typography"><p>Specify the minimum log level to output to rotating files or file output options. If <code>false</code> no log files will be created.</p></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/FoxxMD/logging/blob/53d273daf96985a00fc5276681a5e31900cc8ef3/src/types.ts#L101">src/types.ts:101</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="console" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>console</span><a href="#console" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">console</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"silent"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fatal"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"warn"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"info"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"log"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"verbose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"debug"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"trace"</span></div><div class="tsd-comment tsd-typography"><p>Specify the minimum log level streamed to the console (or docker container)</p></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/FoxxMD/logging/blob/53d273daf96985a00fc5276681a5e31900cc8ef3/src/types.ts#L105">src/types.ts:105</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#level" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>level</span></a><a href="#file" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file</span></a><a href="#console" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>console</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="http://foxxmd.github.io/logging" class="tsd-nav-link">Docs</a><a href="https://github.com/foxxmd/logging" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@foxxmd/logging Docs</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>