v1.0.0-alpha4 (2024-04-10)

This commit is contained in:
Peter Taoussanis 2024-04-10 18:41:24 +02:00
parent 60227941dc
commit cdb344edb8
9 changed files with 63 additions and 21 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -1,3 +1,3 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Telemere 1.0.0-alpha3</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha3</span></span></a></h1><div id="langs"><div class="lang"><a href="index.clj.html">clj</a></div><div class="lang"><a href="index.cljs.html">cljs</a></div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Platforms</span></h3><ul class="index-link"><li class="depth-1"><a href="index.clj.html"><div class="inner">Clojure</div></a></li><li class="depth-1"><a href="index.cljs.html"><div class="inner">ClojureScript</div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha3</span></span></h1><h5 class="license">Released under the <a href="https://www.eclipse.org/legal/epl-v10.html">Eclipse Public License - v 1.0</a></h5><div class="doc"><p>Structured telemetry library for Clojure/Script.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[com.taoensso/telemere "1.0.0-alpha3"]</pre><h2>Platforms</h2><p>This project includes code for multiple platforms, please <strong>choose a platform</strong> to view its documentation:</p><ul><li><a href="index.clj.html">Clojure</a></li><li><a href="index.cljs.html">ClojureScript</a></li></ul></div></body></html>
<html><head><meta charset="UTF-8" /><title>Telemere 1.0.0-alpha4</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha4</span></span></a></h1><div id="langs"><div class="lang"><a href="index.clj.html">clj</a></div><div class="lang"><a href="index.cljs.html">cljs</a></div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Platforms</span></h3><ul class="index-link"><li class="depth-1"><a href="index.clj.html"><div class="inner">Clojure</div></a></li><li class="depth-1"><a href="index.cljs.html"><div class="inner">ClojureScript</div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha4</span></span></h1><h5 class="license">Released under the <a href="https://www.eclipse.org/legal/epl-v10.html">Eclipse Public License - v 1.0</a></h5><div class="doc"><p>Structured telemetry library for Clojure/Script.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[com.taoensso/telemere "1.0.0-alpha4"]</pre><h2>Platforms</h2><p>This project includes code for multiple platforms, please <strong>choose a platform</strong> to view its documentation:</p><ul><li><a href="index.clj.html">Clojure</a></li><li><a href="index.cljs.html">ClojureScript</a></li></ul></div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,4 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.timbre documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha4</span></span></a></h1><div id="langs"><div class="lang"><a href="index.clj.html">clj</a></div><div class="lang current">cljs</div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch current"><a href="taoensso.telemere.timbre.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3"><a href="taoensso.telemere.utils.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.timbre</h1><div class="doc"><pre class="plaintext">Main Timbre macros, reimplemented on top of Telemere.
Intended to help ease migration from Timbre to Telemere.</pre></div></div></body></html>

View file

@ -0,0 +1,28 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.timbre documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha4</span></span></a></h1><div id="langs"><div class="lang current">clj</div><div class="lang"><a href="index.cljs.html">cljs</a></div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch current"><a href="taoensso.telemere.timbre.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3"><a href="taoensso.telemere.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-debug"><div class="inner"><span>debug</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-debugf"><div class="inner"><span>debugf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-error"><div class="inner"><span>error</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-errorf"><div class="inner"><span>errorf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-fatal"><div class="inner"><span>fatal</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-fatalf"><div class="inner"><span>fatalf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-info"><div class="inner"><span>info</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-infof"><div class="inner"><span>infof</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-log"><div class="inner"><span>log</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-log-and-rethrow-errors"><div class="inner"><span>log-and-rethrow-errors</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-log-errors"><div class="inner"><span>log-errors</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-logf"><div class="inner"><span>logf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-logged-future"><div class="inner"><span>logged-future</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-refer-timbre"><div class="inner"><span>refer-timbre</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-report"><div class="inner"><span>report</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-reportf"><div class="inner"><span>reportf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-spy.21"><div class="inner"><span>spy!</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-trace"><div class="inner"><span>trace</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-tracef"><div class="inner"><span>tracef</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-warn"><div class="inner"><span>warn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-warnf"><div class="inner"><span>warnf</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.timbre</h1><div class="doc"><pre class="plaintext">Main Timbre macros, reimplemented on top of Telemere.
Intended to help ease migration from Timbre to Telemere.</pre></div><div class="public anchor" id="var-debug"><h3>debug</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(debug &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-debugf"><h3>debugf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(debugf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-error"><h3>error</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(error &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-errorf"><h3>errorf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(errorf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-fatal"><h3>fatal</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(fatal &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-fatalf"><h3>fatalf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(fatalf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-info"><h3>info</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(info &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-infof"><h3>infof</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(infof &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-log"><h3>log</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(log level &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-log-and-rethrow-errors"><h3>log-and-rethrow-errors</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(log-and-rethrow-errors &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/catch-&gt;error!`.
</pre></div></div><div class="public anchor" id="var-log-errors"><h3>log-errors</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(log-errors &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/catch-&gt;error!`.
</pre></div></div><div class="public anchor" id="var-logf"><h3>logf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(logf level &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-logged-future"><h3>logged-future</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(logged-future &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/catch-&gt;error!`.
</pre></div></div><div class="public anchor" id="var-refer-timbre"><h3>refer-timbre</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(refer-timbre)</code></div><div class="doc"><pre class="plaintext">(require
'[taoensso.telemere.timbre :as timbre :refer
[log trace debug info warn error fatal report
logf tracef debugf infof warnf errorf fatalf reportf
spy]])</pre></div></div><div class="public anchor" id="var-report"><h3>report</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(report &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-reportf"><h3>reportf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(reportf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-spy.21"><h3>spy!</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(spy! form)</code><code>(spy! level form)</code><code>(spy! level form-name form)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/spy!`.
</pre></div></div><div class="public anchor" id="var-trace"><h3>trace</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(trace &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-tracef"><h3>tracef</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(tracef &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-warn"><h3>warn</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(warn &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-warnf"><h3>warnf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(warnf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div></div></body></html>

View file

@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.utils documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha3</span></span></a></h1><div id="langs"><div class="lang"><a href="index.clj.html">clj</a></div><div class="lang current">cljs</div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.timbre-shim.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre-shim</span></div></a></li><li class="depth-3 current"><a href="taoensso.telemere.utils.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-error-in-signal-.3Emaps"><div class="inner"><span>error-in-signal-&gt;maps</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-error-signal.3F"><div class="inner"><span>error-signal?</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-error-fn"><div class="inner"><span>format-error-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-inst-fn"><div class="inner"><span>format-inst-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-nsecs-fn"><div class="inner"><span>format-nsecs-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-.3Eedn-fn"><div class="inner"><span>format-signal-&gt;edn-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-.3Ejson-fn"><div class="inner"><span>format-signal-&gt;json-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-.3Estr-fn"><div class="inner"><span>format-signal-&gt;str-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-prelude-fn"><div class="inner"><span>format-signal-prelude-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-js-console-logger"><div class="inner"><span>js-console-logger</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-minify-signal"><div class="inner"><span>minify-signal</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-newline"><div class="inner"><span>newline</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-pr-edn"><div class="inner"><span>pr-edn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-pr-json"><div class="inner"><span>pr-json</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.utils</h1><div class="doc"><pre class="plaintext">Misc utils useful for Telemere handlers, middleware, etc.
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.utils documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha4</span></span></a></h1><div id="langs"><div class="lang"><a href="index.clj.html">clj</a></div><div class="lang current">cljs</div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.timbre.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3 current"><a href="taoensso.telemere.utils.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-error-in-signal-.3Emaps"><div class="inner"><span>error-in-signal-&gt;maps</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-error-signal.3F"><div class="inner"><span>error-signal?</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-error-fn"><div class="inner"><span>format-error-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-inst-fn"><div class="inner"><span>format-inst-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-nsecs-fn"><div class="inner"><span>format-nsecs-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-.3Eedn-fn"><div class="inner"><span>format-signal-&gt;edn-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-.3Ejson-fn"><div class="inner"><span>format-signal-&gt;json-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-.3Estr-fn"><div class="inner"><span>format-signal-&gt;str-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-format-signal-prelude-fn"><div class="inner"><span>format-signal-prelude-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-js-console-logger"><div class="inner"><span>js-console-logger</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-minify-signal"><div class="inner"><span>minify-signal</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-newline"><div class="inner"><span>newline</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-pr-edn"><div class="inner"><span>pr-edn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.cljs.html#var-pr-json"><div class="inner"><span>pr-json</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.utils</h1><div class="doc"><pre class="plaintext">Misc utils useful for Telemere handlers, middleware, etc.
</pre></div><div class="public anchor" id="var-error-in-signal-.3Emaps"><h3>error-in-signal-&gt;maps</h3><h4 class="lang"><a href="taoensso.telemere.utils.html#var-error-in-signal-.3Emaps">clj</a></h4><h4 class="lang current">cljs</h4><div class="usage"><code>(error-in-signal-&gt;maps signal)</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change.
Returns given signal with possible `:error` replaced by
[{:keys [type msg data]} ...] cause chain.
@ -10,14 +10,14 @@ Returns true iff given signal has an `:error` value, or a `:kind` or `:level`
that indicates that it's an error.</pre></div></div><div class="public anchor" id="var-format-error-fn"><h3>format-error-fn</h3><h4 class="lang"><a href="taoensso.telemere.utils.html#var-format-error-fn">clj</a></h4><h4 class="lang current">cljs</h4><div class="usage"><code>(format-error-fn)</code><code>(format-error-fn {:as _opts})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change.
Returns a (fn format [error]) that:
- Takes a platform error (`Throwable` or `js/Error`).
- Returns a formatted human-readable string</pre></div></div><div class="public anchor" id="var-format-inst-fn"><h3>format-inst-fn</h3><h4 class="lang"><a href="taoensso.telemere.utils.html#var-format-inst-fn">clj</a></h4><h4 class="lang current">cljs</h4><h4 class="added">added in Encore vX.Y.Z (YYYY-MM-DD)</h4><div class="usage"><code>(format-inst-fn)</code><code>(format-inst-fn {:keys [formatter]})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change without notice.
- Returns a formatted human-readable string</pre></div></div><div class="public anchor" id="var-format-inst-fn"><h3>format-inst-fn</h3><h4 class="lang"><a href="taoensso.telemere.utils.html#var-format-inst-fn">clj</a></h4><h4 class="lang current">cljs</h4><h4 class="added">added in Encore v3.98.0 (2024-04-08)</h4><div class="usage"><code>(format-inst-fn)</code><code>(format-inst-fn {:keys [formatter]})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change without notice.
Returns a (fn format [instant]) that:
- Takes a platform instant (`java.time.Instant` or `js/Date`).
- Returns a formatted human-readable string.
Options:
`:zone` (Clj only) - `java.time.ZoneOffset` (defaults to UTC).
`:zone` (Clj only) `java.time.ZoneOffset` (defaults to UTC).
`:formatter`
`java.time.format.DateTimeFormatter` (Clj) or
`goog.i18n.DateTimeFormat` (Cljs),
@ -54,5 +54,5 @@ Returns minimal signal map, removing:
Useful when serializing signals to edn/JSON/etc.</pre></div></div><div class="public anchor" id="var-newline"><h3>newline</h3><h4 class="lang"><a href="taoensso.telemere.utils.html#var-newline">clj</a></h4><h4 class="lang current">cljs</h4><h4 class="added">added in Encore v3.68.0 (2023-09-25)</h4><div class="usage"></div><div class="doc"><pre class="plaintext">Single system newline
</pre></div></div><div class="public anchor" id="var-pr-edn"><h3>pr-edn</h3><h4 class="lang"><a href="taoensso.telemere.utils.html#var-pr-edn">clj</a></h4><h4 class="lang current">cljs</h4><div class="usage"><code>(pr-edn x)</code></div><div class="doc"><pre class="plaintext">Prints given arg to an edn string readable with `read-edn`.
</pre></div></div><div class="public anchor" id="var-pr-json"><h3>pr-json</h3><h4 class="lang current">cljs</h4><h4 class="added">added in Encore vX.Y.Z (YYYY-MM-DD)</h4><div class="usage"><code>(pr-json x)</code></div><div class="doc"><pre class="plaintext">Returns given Cljs argument as JSON string.
</pre></div></div><div class="public anchor" id="var-pr-json"><h3>pr-json</h3><h4 class="lang current">cljs</h4><h4 class="added">added in Encore v3.98.0 (2024-04-08)</h4><div class="usage"><code>(pr-json x)</code></div><div class="doc"><pre class="plaintext">Returns given Cljs argument as JSON string.
</pre></div></div></div></body></html>

View file

@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.utils documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha3</span></span></a></h1><div id="langs"><div class="lang current">clj</div><div class="lang"><a href="index.cljs.html">cljs</a></div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.timbre-shim.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre-shim</span></div></a></li><li class="depth-3 current"><a href="taoensso.telemere.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.telemere.utils.html#var-error-in-signal-.3Emaps"><div class="inner"><span>error-in-signal-&gt;maps</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-error-signal.3F"><div class="inner"><span>error-signal?</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-file-writer"><div class="inner"><span>file-writer</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-error-fn"><div class="inner"><span>format-error-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-inst-fn"><div class="inner"><span>format-inst-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-nsecs-fn"><div class="inner"><span>format-nsecs-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-.3Eedn-fn"><div class="inner"><span>format-signal-&gt;edn-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-.3Ejson-fn"><div class="inner"><span>format-signal-&gt;json-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-.3Estr-fn"><div class="inner"><span>format-signal-&gt;str-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-prelude-fn"><div class="inner"><span>format-signal-prelude-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-host-ip"><div class="inner"><span>host-ip</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-hostname"><div class="inner"><span>hostname</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-minify-signal"><div class="inner"><span>minify-signal</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-newline"><div class="inner"><span>newline</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-pr-edn"><div class="inner"><span>pr-edn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-thread-id"><div class="inner"><span>thread-id</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-thread-name"><div class="inner"><span>thread-name</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.utils</h1><div class="doc"><pre class="plaintext">Misc utils useful for Telemere handlers, middleware, etc.
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.utils documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-alpha4</span></span></a></h1><div id="langs"><div class="lang current">clj</div><div class="lang"><a href="index.cljs.html">cljs</a></div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.timbre.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3 current"><a href="taoensso.telemere.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.telemere.utils.html#var-error-in-signal-.3Emaps"><div class="inner"><span>error-in-signal-&gt;maps</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-error-signal.3F"><div class="inner"><span>error-signal?</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-file-writer"><div class="inner"><span>file-writer</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-error-fn"><div class="inner"><span>format-error-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-inst-fn"><div class="inner"><span>format-inst-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-nsecs-fn"><div class="inner"><span>format-nsecs-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-.3Eedn-fn"><div class="inner"><span>format-signal-&gt;edn-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-.3Ejson-fn"><div class="inner"><span>format-signal-&gt;json-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-.3Estr-fn"><div class="inner"><span>format-signal-&gt;str-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-format-signal-prelude-fn"><div class="inner"><span>format-signal-prelude-fn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-host-ip"><div class="inner"><span>host-ip</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-hostname"><div class="inner"><span>hostname</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-minify-signal"><div class="inner"><span>minify-signal</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-newline"><div class="inner"><span>newline</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-pr-edn"><div class="inner"><span>pr-edn</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-thread-id"><div class="inner"><span>thread-id</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.utils.html#var-thread-name"><div class="inner"><span>thread-name</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.utils</h1><div class="doc"><pre class="plaintext">Misc utils useful for Telemere handlers, middleware, etc.
</pre></div><div class="public anchor" id="var-error-in-signal-.3Emaps"><h3>error-in-signal-&gt;maps</h3><h4 class="lang current">clj</h4><h4 class="lang"><a href="taoensso.telemere.utils.cljs.html#var-error-in-signal-.3Emaps">cljs</a></h4><div class="usage"><code>(error-in-signal-&gt;maps signal)</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change.
Returns given signal with possible `:error` replaced by
[{:keys [type msg data]} ...] cause chain.
@ -19,14 +19,14 @@ Writers MUST ALWAYS be manually closed after use!
Useful for handlers that write to files, etc.</pre></div></div><div class="public anchor" id="var-format-error-fn"><h3>format-error-fn</h3><h4 class="lang current">clj</h4><h4 class="lang"><a href="taoensso.telemere.utils.cljs.html#var-format-error-fn">cljs</a></h4><div class="usage"><code>(format-error-fn)</code><code>(format-error-fn {:as _opts})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change.
Returns a (fn format [error]) that:
- Takes a platform error (`Throwable` or `js/Error`).
- Returns a formatted human-readable string</pre></div></div><div class="public anchor" id="var-format-inst-fn"><h3>format-inst-fn</h3><h4 class="lang current">clj</h4><h4 class="lang"><a href="taoensso.telemere.utils.cljs.html#var-format-inst-fn">cljs</a></h4><h4 class="added">added in Encore vX.Y.Z (YYYY-MM-DD)</h4><div class="usage"><code>(format-inst-fn)</code><code>(format-inst-fn {:keys [formatter zone], :or {formatter java.time.format.DateTimeFormatter/ISO_INSTANT, zone java.time.ZoneOffset/UTC}})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change without notice.
- Returns a formatted human-readable string</pre></div></div><div class="public anchor" id="var-format-inst-fn"><h3>format-inst-fn</h3><h4 class="lang current">clj</h4><h4 class="lang"><a href="taoensso.telemere.utils.cljs.html#var-format-inst-fn">cljs</a></h4><h4 class="added">added in Encore v3.98.0 (2024-04-08)</h4><div class="usage"><code>(format-inst-fn)</code><code>(format-inst-fn {:keys [formatter zone], :or {formatter java.time.format.DateTimeFormatter/ISO_INSTANT, zone java.time.ZoneOffset/UTC}})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change without notice.
Returns a (fn format [instant]) that:
- Takes a platform instant (`java.time.Instant` or `js/Date`).
- Returns a formatted human-readable string.
Options:
`:zone` (Clj only) - `java.time.ZoneOffset` (defaults to UTC).
`:zone` (Clj only) `java.time.ZoneOffset` (defaults to UTC).
`:formatter`
`java.time.format.DateTimeFormatter` (Clj) or
`goog.i18n.DateTimeFormat` (Cljs),