Skip to content

Commit fc0370e

Browse files
terehovterehov
committed
Fixed some tiny but embarrassing 🙈 typos. Many thanks to @tsarnow for your eagle eye 🕵️
1 parent bbaaffd commit fc0370e

18 files changed

+116
-113
lines changed

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
🗃 **_Pretty_ or `JSON` output**<br>
2020
🦸 **Custom pluggable loggers**<br>
2121
💅 **Object and error interpolation**<br>
22-
🕵️‍ **Error code frame**<br>
22+
🕵️‍ **Code surrounding error position (_code frame_)**<br>
2323
🤓 **Stack trace through native V8 API**<br>
2424
🏗 **Works for TypeScript and JavaScript**<br>
25-
🧲 **Optionally catch-all `console` logs**<br>
25+
🧲 **Optionally catch all `console` logs**<br>
2626
✍️ **well documented**<br>
2727
😎 **100% test coverage**<br>
2828

@@ -81,9 +81,9 @@ 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+
* **Code 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
86-
* **Instance Name:** Logs capture instance name (default hos name) making it easy to distinguish logs coming from different instances (e.g. serverless)
86+
* **Instance Name:** Logs capture instance name (default host 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)
8888
* **Highly configurable:** All settings can be changed through a typed object
8989
* **Short paths:** Paths are relative to the root of the application folder
@@ -204,7 +204,7 @@ Usually, only _Errors_ and log level `trace` logs would capture the entire stack
204204
By enabling this option **every** stack trace of every log message is going to be captured.
205205

206206
```typescript
207-
new Logger({ exposeStack: true });
207+
new Logger({ exposeStack: true });
208208
```
209209

210210
![tslog with a stack trace](https://raw.githubusercontent.com/fullstack-build/tslog/master/docs/assets/tslog_stacktrace.png)
@@ -290,7 +290,7 @@ like sending a message to _Slack_ or _Telegram_ in case of an urgent error.
290290
When attaching a transport, you _must_ implement every log level.
291291
All of them could be potentially handled by the same function, though.
292292

293-
Each _transport_ can hav its own `minLevel`.
293+
Each _transport_ can have its own `minLevel`.
294294

295295
##### Simple transport example
296296

‎docs/assets/tslog_v1_release.png‎

23.4 KB
Loading

‎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/3026de4/src/index.ts#L64">index.ts:64</a></li>
124+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L64">index.ts:64</a></li>
153+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L117">index.ts:117</a></li>
175+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L147">index.ts:147</a></li>
212+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L171">index.ts:171</a></li>
243+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L179">index.ts:179</a></li>
274+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L155">index.ts:155</a></li>
305+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L131">index.ts:131</a></li>
336+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L139">index.ts:139</a></li>
367+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/index.ts#L163">index.ts:163</a></li>
398+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L33">interfaces.ts:33</a></li>
108+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L21">interfaces.ts:21</a></li>
128+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L27">interfaces.ts:27</a></li>
143+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L185">interfaces.ts:185</a></li>
158+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ <h3>Highlights</h3>
8282
🗃 <strong><em>Pretty</em> or <code>JSON</code> output</strong><br>
8383
🦸 <strong>Custom pluggable loggers</strong><br>
8484
💅 <strong>Object and error interpolation</strong><br>
85-
🕵️‍ <strong>Error code frame</strong><br>
85+
🕵️‍ <strong>Code surrounding error position (<em>code frame</em>)</strong><br>
8686
🤓 <strong>Stack trace through native V8 API</strong><br>
8787
🏗 <strong>Works for TypeScript and JavaScript</strong><br>
88-
🧲 <strong>Optionally catch-all <code>console</code> logs</strong><br>
88+
🧲 <strong>Optionally catch all <code>console</code> logs</strong><br>
8989
✍️ <strong>well documented</strong><br>
9090
😎 <strong>100% test coverage</strong><br></p>
9191
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
@@ -135,9 +135,9 @@ <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> <code>tslog</code> captures and displays the source code that lead to an error, making it easier to debug</li>
138+
<li><strong>Code 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>
140-
<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>
140+
<li><strong>Instance Name:</strong> Logs capture instance name (default host 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>
142142
<li><strong>Highly configurable:</strong> All settings can be changed through a typed object</li>
143143
<li><strong>Short paths:</strong> Paths are relative to the root of the application folder</li>
@@ -243,7 +243,7 @@ <h5><code>exposeStack</code></h5>
243243
</a>
244244
<p> <code>default: false</code></p>
245245
<p>Usually, only <em>Errors</em> and log level <code>trace</code> logs would capture the entire stack trace.<br>By enabling this option <strong>every</strong> stack trace of every log message is going to be captured.</p>
246-
<pre><code class="language-typescript"> <span class="hljs-keyword">new</span> Logger({ exposeStack: <span class="hljs-literal">true</span> });</code></pre>
246+
<pre><code class="language-typescript"><span class="hljs-keyword">new</span> Logger({ exposeStack: <span class="hljs-literal">true</span> });</code></pre>
247247
<p><img src="https://raw.githubusercontent.com/fullstack-build/tslog/master/docs/assets/tslog_stacktrace.png" alt="tslog with a stack trace"></p>
248248
<blockquote>
249249
<p><strong>Hint:</strong> When working in an IDE like <em>WebStorm</em> or an editor like <em>VSCode</em> you can click on the path leading you directly to the position in your source code. </p>
@@ -314,7 +314,7 @@ <h4>Transports</h4>
314314
like sending a message to <em>Slack</em> or <em>Telegram</em> in case of an urgent error. </p>
315315
<p>When attaching a transport, you <em>must</em> implement every log level.
316316
All of them could be potentially handled by the same function, though.</p>
317-
<p>Each <em>transport</em> can hav its own <code>minLevel</code>. </p>
317+
<p>Each <em>transport</em> can have its own <code>minLevel</code>. </p>
318318
<a href="#simple-transport-example" id="simple-transport-example" style="color: inherit; text-decoration: none;">
319319
<h5>Simple transport example</h5>
320320
</a>

‎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/3026de4/src/interfaces.ts#L221">interfaces.ts:221</a></li>
106+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L219">interfaces.ts:219</a></li>
116+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L220">interfaces.ts:220</a></li>
126+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L224">interfaces.ts:224</a></li>
136+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L222">interfaces.ts:222</a></li>
146+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/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/3026de4/src/interfaces.ts#L223">interfaces.ts:223</a></li>
156+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/bbaaffd/src/interfaces.ts#L223">interfaces.ts:223</a></li>
157157
</ul>
158158
</aside>
159159
</section>

0 commit comments

Comments
 (0)