Skip to content

Commit 12fd3ad

Browse files
terehovterehov
committed
tiny clean up
1 parent bc44439 commit 12fd3ad

17 files changed

+104
-102
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,5 @@ common/temp/
6868
# don't check in build files
6969
**/dist
7070
/temp/
71+
# Don't commit tsdoc meta
72+
/src/tsdoc-metadata.json

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ log.fatal(new Error("I am a pretty Error with a stacktrace."));
8181
* **Source maps lookup:** Shows exact position also in TypeScript code (compile-to-JS), one click to IDE position.
8282
* **Stack trace:** Callsites through native <a href="https://v8.dev/docs/stack-trace-api" target="_blank">_V8 stack trace API_</a>, excludes internal entries
8383
* **Pretty Error:** Errors and stack traces printed in a structured way and fully accessible through _JSON_ (e.g. external Log services)
84-
* **Stack frame:** tslog captures and displays the source code that lead to an error, making it easier to debug
84+
* **Stack frame:** `tslog` captures and displays the source code that lead to an error, making it easier to debug
8585
* **Object/JSON highlighting:** Nicely prints out an object
8686
* **Instance Name:** Logs capture instance name (default hos name) making it easy to distinguish logs coming from different instances (e.g. serverless)
8787
* **Named Logger:** Logger can be named (e.g. useful for packages/modules and monorepos)

‎docs/tsdoc/classes/logger.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h3>constructor</h3>
121121
<li class="tsd-description">
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L64">index.ts:64</a></li>
124+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L64">index.ts:64</a></li>
125125
</ul>
126126
</aside>
127127
<div class="tsd-comment tsd-typography">
@@ -150,7 +150,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> settings</h3>
150150
<div class="tsd-signature tsd-kind-icon">settings<span class="tsd-signature-symbol">:</span> <a href="../interfaces/isettings.html" class="tsd-signature-type">ISettings</a></div>
151151
<aside class="tsd-sources">
152152
<ul>
153-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L64">index.ts:64</a></li>
153+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L64">index.ts:64</a></li>
154154
</ul>
155155
</aside>
156156
<div class="tsd-comment tsd-typography">
@@ -172,7 +172,7 @@ <h3>attach<wbr>Transport</h3>
172172
<li class="tsd-description">
173173
<aside class="tsd-sources">
174174
<ul>
175-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L117">index.ts:117</a></li>
175+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L117">index.ts:117</a></li>
176176
</ul>
177177
</aside>
178178
<div class="tsd-comment tsd-typography">
@@ -209,7 +209,7 @@ <h3>debug</h3>
209209
<li class="tsd-description">
210210
<aside class="tsd-sources">
211211
<ul>
212-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L147">index.ts:147</a></li>
212+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L147">index.ts:147</a></li>
213213
</ul>
214214
</aside>
215215
<div class="tsd-comment tsd-typography">
@@ -240,7 +240,7 @@ <h3>error</h3>
240240
<li class="tsd-description">
241241
<aside class="tsd-sources">
242242
<ul>
243-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L171">index.ts:171</a></li>
243+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L171">index.ts:171</a></li>
244244
</ul>
245245
</aside>
246246
<div class="tsd-comment tsd-typography">
@@ -271,7 +271,7 @@ <h3>fatal</h3>
271271
<li class="tsd-description">
272272
<aside class="tsd-sources">
273273
<ul>
274-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L179">index.ts:179</a></li>
274+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L179">index.ts:179</a></li>
275275
</ul>
276276
</aside>
277277
<div class="tsd-comment tsd-typography">
@@ -302,7 +302,7 @@ <h3>info</h3>
302302
<li class="tsd-description">
303303
<aside class="tsd-sources">
304304
<ul>
305-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L155">index.ts:155</a></li>
305+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L155">index.ts:155</a></li>
306306
</ul>
307307
</aside>
308308
<div class="tsd-comment tsd-typography">
@@ -333,7 +333,7 @@ <h3>silly</h3>
333333
<li class="tsd-description">
334334
<aside class="tsd-sources">
335335
<ul>
336-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L131">index.ts:131</a></li>
336+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L131">index.ts:131</a></li>
337337
</ul>
338338
</aside>
339339
<div class="tsd-comment tsd-typography">
@@ -364,7 +364,7 @@ <h3>trace</h3>
364364
<li class="tsd-description">
365365
<aside class="tsd-sources">
366366
<ul>
367-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L139">index.ts:139</a></li>
367+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L139">index.ts:139</a></li>
368368
</ul>
369369
</aside>
370370
<div class="tsd-comment tsd-typography">
@@ -395,7 +395,7 @@ <h3>warn</h3>
395395
<li class="tsd-description">
396396
<aside class="tsd-sources">
397397
<ul>
398-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/index.ts#L163">index.ts:163</a></li>
398+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/index.ts#L163">index.ts:163</a></li>
399399
</ul>
400400
</aside>
401401
<div class="tsd-comment tsd-typography">

‎docs/tsdoc/globals.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h3>TLog<wbr>Level<wbr>Color</h3>
105105
<div class="tsd-signature tsd-kind-icon">TLog<wbr>Level<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
106106
<aside class="tsd-sources">
107107
<ul>
108-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L33">interfaces.ts:33</a></li>
108+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L33">interfaces.ts:33</a></li>
109109
</ul>
110110
</aside>
111111
<div class="tsd-comment tsd-typography">
@@ -125,7 +125,7 @@ <h3>TLog<wbr>Level<wbr>Id</h3>
125125
<div class="tsd-signature tsd-kind-icon">TLog<wbr>Level<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><a href="interfaces/iloglevel.html" class="tsd-signature-type">ILogLevel</a></div>
126126
<aside class="tsd-sources">
127127
<ul>
128-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L21">interfaces.ts:21</a></li>
128+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L21">interfaces.ts:21</a></li>
129129
</ul>
130130
</aside>
131131
<div class="tsd-comment tsd-typography">
@@ -140,7 +140,7 @@ <h3>TLog<wbr>Level<wbr>Name</h3>
140140
<div class="tsd-signature tsd-kind-icon">TLog<wbr>Level<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ILogLevel</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">TLogLevelId</span><span class="tsd-signature-symbol">]</span></div>
141141
<aside class="tsd-sources">
142142
<ul>
143-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L27">interfaces.ts:27</a></li>
143+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L27">interfaces.ts:27</a></li>
144144
</ul>
145145
</aside>
146146
<div class="tsd-comment tsd-typography">
@@ -155,7 +155,7 @@ <h3>TTransport<wbr>Logger</h3>
155155
<div class="tsd-signature tsd-kind-icon">TTransport<wbr>Logger&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
156156
<aside class="tsd-sources">
157157
<ul>
158-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L185">interfaces.ts:185</a></li>
158+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L185">interfaces.ts:185</a></li>
159159
</ul>
160160
</aside>
161161
<div class="tsd-comment tsd-typography">

‎docs/tsdoc/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h3>All Features</h3>
135135
<li><strong>Source maps lookup:</strong> Shows exact position also in TypeScript code (compile-to-JS), one click to IDE position. </li>
136136
<li><strong>Stack trace:</strong> Callsites through native <a href="https://v8.dev/docs/stack-trace-api" target="_blank"><em>V8 stack trace API</em></a>, excludes internal entries </li>
137137
<li><strong>Pretty Error:</strong> Errors and stack traces printed in a structured way and fully accessible through <em>JSON</em> (e.g. external Log services) </li>
138-
<li><strong>Stack frame:</strong> tslog captures and displays the source code that lead to an error, making it easier to debug</li>
138+
<li><strong>Stack frame:</strong> <code>tslog</code> captures and displays the source code that lead to an error, making it easier to debug</li>
139139
<li><strong>Object/JSON highlighting:</strong> Nicely prints out an object </li>
140140
<li><strong>Instance Name:</strong> Logs capture instance name (default hos name) making it easy to distinguish logs coming from different instances (e.g. serverless)</li>
141141
<li><strong>Named Logger:</strong> Logger can be named (e.g. useful for packages/modules and monorepos)</li>

‎docs/tsdoc/interfaces/icodeframe.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h3>column<wbr>Number</h3>
103103
<div class="tsd-signature tsd-kind-icon">column<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
104104
<aside class="tsd-sources">
105105
<ul>
106-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L221">interfaces.ts:221</a></li>
106+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L221">interfaces.ts:221</a></li>
107107
</ul>
108108
</aside>
109109
</section>
@@ -113,7 +113,7 @@ <h3>first<wbr>Line<wbr>Number</h3>
113113
<div class="tsd-signature tsd-kind-icon">first<wbr>Line<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
114114
<aside class="tsd-sources">
115115
<ul>
116-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L219">interfaces.ts:219</a></li>
116+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L219">interfaces.ts:219</a></li>
117117
</ul>
118118
</aside>
119119
</section>
@@ -123,7 +123,7 @@ <h3>line<wbr>Number</h3>
123123
<div class="tsd-signature tsd-kind-icon">line<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
124124
<aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L220">interfaces.ts:220</a></li>
126+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L220">interfaces.ts:220</a></li>
127127
</ul>
128128
</aside>
129129
</section>
@@ -133,7 +133,7 @@ <h3>lines<wbr>After</h3>
133133
<div class="tsd-signature tsd-kind-icon">lines<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
134134
<aside class="tsd-sources">
135135
<ul>
136-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L224">interfaces.ts:224</a></li>
136+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L224">interfaces.ts:224</a></li>
137137
</ul>
138138
</aside>
139139
</section>
@@ -143,7 +143,7 @@ <h3>lines<wbr>Before</h3>
143143
<div class="tsd-signature tsd-kind-icon">lines<wbr>Before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
144144
<aside class="tsd-sources">
145145
<ul>
146-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L222">interfaces.ts:222</a></li>
146+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L222">interfaces.ts:222</a></li>
147147
</ul>
148148
</aside>
149149
</section>
@@ -153,7 +153,7 @@ <h3>relevant<wbr>Line</h3>
153153
<div class="tsd-signature tsd-kind-icon">relevant<wbr>Line<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
154154
<aside class="tsd-sources">
155155
<ul>
156-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L223">interfaces.ts:223</a></li>
156+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L223">interfaces.ts:223</a></li>
157157
</ul>
158158
</aside>
159159
</section>

‎docs/tsdoc/interfaces/ierrorobject.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> code<wbr>Frame</h3>
102102
<div class="tsd-signature tsd-kind-icon">code<wbr>Frame<span class="tsd-signature-symbol">:</span> <a href="icodeframe.html" class="tsd-signature-type">ICodeFrame</a></div>
103103
<aside class="tsd-sources">
104104
<ul>
105-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L178">interfaces.ts:178</a></li>
105+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L178">interfaces.ts:178</a></li>
106106
</ul>
107107
</aside>
108108
<div class="tsd-comment tsd-typography">
@@ -117,7 +117,7 @@ <h3>is<wbr>Error</h3>
117117
<div class="tsd-signature tsd-kind-icon">is<wbr>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span></div>
118118
<aside class="tsd-sources">
119119
<ul>
120-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L170">interfaces.ts:170</a></li>
120+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L170">interfaces.ts:170</a></li>
121121
</ul>
122122
</aside>
123123
<div class="tsd-comment tsd-typography">
@@ -132,7 +132,7 @@ <h3>message</h3>
132132
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133133
<aside class="tsd-sources">
134134
<ul>
135-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L174">interfaces.ts:174</a></li>
135+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L174">interfaces.ts:174</a></li>
136136
</ul>
137137
</aside>
138138
<div class="tsd-comment tsd-typography">
@@ -147,7 +147,7 @@ <h3>name</h3>
147147
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
148148
<aside class="tsd-sources">
149149
<ul>
150-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L172">interfaces.ts:172</a></li>
150+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L172">interfaces.ts:172</a></li>
151151
</ul>
152152
</aside>
153153
<div class="tsd-comment tsd-typography">
@@ -162,7 +162,7 @@ <h3>stack</h3>
162162
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <a href="istackframe.html" class="tsd-signature-type">IStackFrame</a><span class="tsd-signature-symbol">[]</span></div>
163163
<aside class="tsd-sources">
164164
<ul>
165-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L176">interfaces.ts:176</a></li>
165+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L176">interfaces.ts:176</a></li>
166166
</ul>
167167
</aside>
168168
<div class="tsd-comment tsd-typography">

‎docs/tsdoc/interfaces/ijsonhighlightcolors.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>boolean</h3>
102102
<div class="tsd-signature tsd-kind-icon">boolean<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103103
<aside class="tsd-sources">
104104
<ul>
105-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L202">interfaces.ts:202</a></li>
105+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L202">interfaces.ts:202</a></li>
106106
</ul>
107107
</aside>
108108
</section>
@@ -112,7 +112,7 @@ <h3>key</h3>
112112
<div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L200">interfaces.ts:200</a></li>
115+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L200">interfaces.ts:200</a></li>
116116
</ul>
117117
</aside>
118118
</section>
@@ -122,7 +122,7 @@ <h3>null</h3>
122122
<div class="tsd-signature tsd-kind-icon">null<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
123123
<aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L203">interfaces.ts:203</a></li>
125+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L203">interfaces.ts:203</a></li>
126126
</ul>
127127
</aside>
128128
</section>
@@ -132,7 +132,7 @@ <h3>number</h3>
132132
<div class="tsd-signature tsd-kind-icon">number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133133
<aside class="tsd-sources">
134134
<ul>
135-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L199">interfaces.ts:199</a></li>
135+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L199">interfaces.ts:199</a></li>
136136
</ul>
137137
</aside>
138138
</section>
@@ -142,7 +142,7 @@ <h3>string</h3>
142142
<div class="tsd-signature tsd-kind-icon">string<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
143143
<aside class="tsd-sources">
144144
<ul>
145-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/940be29/src/interfaces.ts#L201">interfaces.ts:201</a></li>
145+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bc44439/src/interfaces.ts#L201">interfaces.ts:201</a></li>
146146
</ul>
147147
</aside>
148148
</section>

0 commit comments

Comments
 (0)