Skip to content

Commit f7c8cfb

Browse files
committed
Add Docu
1 parent 23ee248 commit f7c8cfb

19 files changed

+238
-214
lines changed

docs/api_extractor/tslog.api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,9 @@ export interface ISettings extends ISettingsParam {
142142
// (undocumented)
143143
logLevelsColors: TLogLevelColor;
144144
// (undocumented)
145-
maskPlaceholder: string;
145+
maskAny: (string | number)[];
146146
// (undocumented)
147-
maskStrings: string[];
147+
maskPlaceholder: string;
148148
// (undocumented)
149149
maskValuesOfKeys: (number | string)[];
150150
// (undocumented)
@@ -193,8 +193,8 @@ export interface ISettingsParam {
193193
instanceName?: string;
194194
jsonInspectOptions?: InspectOptions;
195195
logLevelsColors?: TLogLevelColor;
196+
maskAny?: (string | number)[];
196197
maskPlaceholder?: string;
197-
maskStrings?: string[];
198198
maskValuesOfKeys?: (number | string)[];
199199
minLevel?: TLogLevelName;
200200
name?: string;
@@ -226,7 +226,7 @@ export interface IStackFrame {
226226

227227
// @public
228228
export interface IStd {
229-
write: Function;
229+
write: (message: string) => void;
230230
}
231231

232232
// @public

docs/tsdoc/assets/js/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/tsdoc/classes/logger.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ <h3>constructor</h3>
124124
<li class="tsd-description">
125125
<aside class="tsd-sources">
126126
<ul>
127-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L76">index.ts:76</a></li>
127+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L76">index.ts:76</a></li>
128128
</ul>
129129
</aside>
130130
<div class="tsd-comment tsd-typography">
@@ -160,7 +160,7 @@ <h3>settings</h3>
160160
<li class="tsd-description">
161161
<aside class="tsd-sources">
162162
<ul>
163-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L158">index.ts:158</a></li>
163+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L158">index.ts:158</a></li>
164164
</ul>
165165
</aside>
166166
<div class="tsd-comment tsd-typography">
@@ -185,7 +185,7 @@ <h3>attach<wbr>Transport</h3>
185185
<li class="tsd-description">
186186
<aside class="tsd-sources">
187187
<ul>
188-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L251">index.ts:251</a></li>
188+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L251">index.ts:251</a></li>
189189
</ul>
190190
</aside>
191191
<div class="tsd-comment tsd-typography">
@@ -222,7 +222,7 @@ <h3>debug</h3>
222222
<li class="tsd-description">
223223
<aside class="tsd-sources">
224224
<ul>
225-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L281">index.ts:281</a></li>
225+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L281">index.ts:281</a></li>
226226
</ul>
227227
</aside>
228228
<div class="tsd-comment tsd-typography">
@@ -253,7 +253,7 @@ <h3>error</h3>
253253
<li class="tsd-description">
254254
<aside class="tsd-sources">
255255
<ul>
256-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L305">index.ts:305</a></li>
256+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L305">index.ts:305</a></li>
257257
</ul>
258258
</aside>
259259
<div class="tsd-comment tsd-typography">
@@ -284,7 +284,7 @@ <h3>fatal</h3>
284284
<li class="tsd-description">
285285
<aside class="tsd-sources">
286286
<ul>
287-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L313">index.ts:313</a></li>
287+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L313">index.ts:313</a></li>
288288
</ul>
289289
</aside>
290290
<div class="tsd-comment tsd-typography">
@@ -315,7 +315,7 @@ <h3>get<wbr>Child<wbr>Logger</h3>
315315
<li class="tsd-description">
316316
<aside class="tsd-sources">
317317
<ul>
318-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L236">index.ts:236</a></li>
318+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L236">index.ts:236</a></li>
319319
</ul>
320320
</aside>
321321
<div class="tsd-comment tsd-typography">
@@ -346,7 +346,7 @@ <h3>info</h3>
346346
<li class="tsd-description">
347347
<aside class="tsd-sources">
348348
<ul>
349-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L289">index.ts:289</a></li>
349+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L289">index.ts:289</a></li>
350350
</ul>
351351
</aside>
352352
<div class="tsd-comment tsd-typography">
@@ -377,7 +377,7 @@ <h3>pretty<wbr>Error</h3>
377377
<li class="tsd-description">
378378
<aside class="tsd-sources">
379379
<ul>
380-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L327">index.ts:327</a></li>
380+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L327">index.ts:327</a></li>
381381
</ul>
382382
</aside>
383383
<div class="tsd-comment tsd-typography">
@@ -444,7 +444,7 @@ <h3>set<wbr>Settings</h3>
444444
<li class="tsd-description">
445445
<aside class="tsd-sources">
446446
<ul>
447-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L175">index.ts:175</a></li>
447+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L175">index.ts:175</a></li>
448448
</ul>
449449
</aside>
450450
<div class="tsd-comment tsd-typography">
@@ -482,7 +482,7 @@ <h3>silly</h3>
482482
<li class="tsd-description">
483483
<aside class="tsd-sources">
484484
<ul>
485-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L265">index.ts:265</a></li>
485+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L265">index.ts:265</a></li>
486486
</ul>
487487
</aside>
488488
<div class="tsd-comment tsd-typography">
@@ -513,7 +513,7 @@ <h3>trace</h3>
513513
<li class="tsd-description">
514514
<aside class="tsd-sources">
515515
<ul>
516-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L273">index.ts:273</a></li>
516+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L273">index.ts:273</a></li>
517517
</ul>
518518
</aside>
519519
<div class="tsd-comment tsd-typography">
@@ -544,7 +544,7 @@ <h3>warn</h3>
544544
<li class="tsd-description">
545545
<aside class="tsd-sources">
546546
<ul>
547-
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/281972e/src/index.ts#L297">index.ts:297</a></li>
547+
<li>Defined in <a href="https://github.com/fullstack-build/tslog/blob/23ee248/src/index.ts#L297">index.ts:297</a></li>
548548
</ul>
549549
</aside>
550550
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)