@vvlad1973/simple-logger 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1000 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width, initial-scale=1">
8
+ <title> SimpleLogger</title>
9
+
10
+ <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11
+ <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12
+ <script src="./build/entry.js"></script>
13
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19
+ <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20
+ <link type="text/css" rel="stylesheet" href="styles/app.min.css">
21
+ <link type="text/css" rel="stylesheet" href="styles/iframe.css">
22
+ <link type="text/css" rel="stylesheet" href="">
23
+ <script async defer src="https://buttons.github.io/buttons.js"></script>
24
+
25
+
26
+ </head>
27
+
28
+
29
+
30
+ <body class="layout small-header">
31
+ <div id="stickyNavbarOverlay"></div>
32
+
33
+
34
+ <div class="top-nav">
35
+ <div class="inner">
36
+ <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37
+ <span aria-hidden="true"></span>
38
+ <span aria-hidden="true"></span>
39
+ <span aria-hidden="true"></span>
40
+ </a>
41
+ <div class="logo">
42
+
43
+
44
+ </div>
45
+ <div class="menu">
46
+
47
+ <div class="navigation">
48
+ <a
49
+ href="index.html"
50
+ class="link"
51
+ >
52
+ Documentation
53
+ </a>
54
+
55
+
56
+
57
+ </div>
58
+ </div>
59
+ </div>
60
+ </div>
61
+ <div id="main">
62
+ <div
63
+ class="sidebar "
64
+ id="sidebarNav"
65
+ >
66
+
67
+ <nav>
68
+
69
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-SimpleLogger.html">SimpleLogger</a></li></ul><h3>Classes</h3><ul><li><a href="module-SimpleLogger.SimpleLogger.html">SimpleLogger</a></li></ul></div>
70
+
71
+ </nav>
72
+ </div>
73
+ <div class="core" id="main-content-wrapper">
74
+ <div class="content">
75
+ <header class="page-title">
76
+ <p>Class</p>
77
+ <h1>SimpleLogger</h1>
78
+ </header>
79
+
80
+
81
+
82
+
83
+
84
+ <section>
85
+
86
+ <header>
87
+
88
+ <h2><span class="attribs"><span class="type-signature"></span></span>
89
+ <span class="ancestors"><a href="module-SimpleLogger.html">SimpleLogger</a>.</span>SimpleLogger<span class="signature">(level<span class="signature-attributes">opt</span>, externalLogger<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
90
+
91
+ <div class="class-description">A simple logger class with various logging levels.</div>
92
+
93
+
94
+ </header>
95
+
96
+ <article>
97
+ <div class="container-overview">
98
+
99
+
100
+ <div class='vertical-section'>
101
+ <div class="members">
102
+ <div class="member">
103
+ <div class=name>
104
+ <span class="tag">Constructor</span>
105
+ </div>
106
+
107
+
108
+
109
+
110
+ <h4 class="name" id="SimpleLogger">
111
+ <a class="href-link" href="#SimpleLogger">#</a>
112
+
113
+ <span class="code-name">
114
+
115
+ new SimpleLogger<span class="signature">(level<span class="signature-attributes">opt</span>, externalLogger<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span>
116
+
117
+ </span>
118
+ </h4>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+ <h5>Parameters:</h5>
133
+
134
+ <div class="table-container">
135
+ <table class="params table">
136
+ <thead>
137
+ <tr>
138
+
139
+ <th>Name</th>
140
+
141
+
142
+ <th>Type</th>
143
+
144
+
145
+ <th>Attributes</th>
146
+
147
+
148
+
149
+ <th>Default</th>
150
+
151
+
152
+ <th class="last">Description</th>
153
+ </tr>
154
+ </thead>
155
+
156
+ <tbody>
157
+
158
+
159
+
160
+ <tr class="deep-level-0">
161
+
162
+ <td class="name"><code>level</code></td>
163
+
164
+
165
+ <td class="type">
166
+
167
+
168
+ <code class="param-type">string</code>
169
+
170
+
171
+
172
+ </td>
173
+
174
+
175
+ <td class="attributes">
176
+
177
+ &lt;optional><br>
178
+
179
+
180
+
181
+
182
+
183
+ </td>
184
+
185
+
186
+
187
+ <td class="default">
188
+
189
+ 'info'
190
+
191
+ </td>
192
+
193
+
194
+ <td class="description last">Initial logging level.</td>
195
+ </tr>
196
+
197
+
198
+
199
+
200
+
201
+ <tr class="deep-level-0">
202
+
203
+ <td class="name"><code>externalLogger</code></td>
204
+
205
+
206
+ <td class="type">
207
+
208
+
209
+ <code class="param-type">ExternalLogger</code>
210
+ |
211
+
212
+ <code class="param-type">undefined</code>
213
+ |
214
+
215
+ <code class="param-type">null</code>
216
+
217
+
218
+
219
+ </td>
220
+
221
+
222
+ <td class="attributes">
223
+
224
+ &lt;optional><br>
225
+
226
+
227
+
228
+
229
+
230
+ </td>
231
+
232
+
233
+
234
+ <td class="default">
235
+
236
+ null
237
+
238
+ </td>
239
+
240
+
241
+ <td class="description last">Optional external logger to use.</td>
242
+ </tr>
243
+
244
+
245
+
246
+ </tbody>
247
+ </table>
248
+ </div>
249
+
250
+
251
+
252
+
253
+
254
+ <dl class="details">
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+ <p class="tag-source">
287
+ <a href="simple-logger.ts.html" class="button">View Source</a>
288
+ <span>
289
+ <a href="simple-logger.ts.html">simple-logger.ts</a>, <a href="simple-logger.ts.html#line22">line 22</a>
290
+ </span>
291
+ </p>
292
+
293
+ </dl>
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ </div>
317
+ </div>
318
+ </div>
319
+
320
+
321
+ </div>
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+ <div class='vertical-section'>
339
+ <h1>Methods</h1>
340
+ <div class="members">
341
+
342
+ <div class="member">
343
+
344
+
345
+
346
+ <h4 class="name" id="logFunctionEnd">
347
+ <a class="href-link" href="#logFunctionEnd">#</a>
348
+
349
+ <span class="code-name">
350
+
351
+ logFunctionEnd<span class="signature">(functionName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span>
352
+
353
+ </span>
354
+ </h4>
355
+
356
+
357
+
358
+
359
+ <div class="description">
360
+ Logs the end of a function.
361
+ </div>
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+ <h5>Parameters:</h5>
373
+
374
+ <div class="table-container">
375
+ <table class="params table">
376
+ <thead>
377
+ <tr>
378
+
379
+ <th>Name</th>
380
+
381
+
382
+ <th>Type</th>
383
+
384
+
385
+ <th>Attributes</th>
386
+
387
+
388
+
389
+
390
+ <th class="last">Description</th>
391
+ </tr>
392
+ </thead>
393
+
394
+ <tbody>
395
+
396
+
397
+
398
+ <tr class="deep-level-0">
399
+
400
+ <td class="name"><code>functionName</code></td>
401
+
402
+
403
+ <td class="type">
404
+
405
+
406
+ <code class="param-type">string</code>
407
+
408
+
409
+
410
+ </td>
411
+
412
+
413
+ <td class="attributes">
414
+
415
+ &lt;optional><br>
416
+
417
+
418
+
419
+
420
+
421
+ </td>
422
+
423
+
424
+
425
+
426
+ <td class="description last">Optional function name to log.</td>
427
+ </tr>
428
+
429
+
430
+
431
+ </tbody>
432
+ </table>
433
+ </div>
434
+
435
+
436
+
437
+
438
+
439
+ <dl class="details">
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+ <p class="tag-source">
472
+ <a href="simple-logger.ts.html" class="button">View Source</a>
473
+ <span>
474
+ <a href="simple-logger.ts.html">simple-logger.ts</a>, <a href="simple-logger.ts.html#line211">line 211</a>
475
+ </span>
476
+ </p>
477
+
478
+ </dl>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+ </div>
501
+
502
+ <div class="member">
503
+
504
+
505
+
506
+ <h4 class="name" id="logFunctionStart">
507
+ <a class="href-link" href="#logFunctionStart">#</a>
508
+
509
+ <span class="code-name">
510
+
511
+ logFunctionStart<span class="signature">(functionName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span>
512
+
513
+ </span>
514
+ </h4>
515
+
516
+
517
+
518
+
519
+ <div class="description">
520
+ Logs the start of a function.
521
+ </div>
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+ <h5>Parameters:</h5>
533
+
534
+ <div class="table-container">
535
+ <table class="params table">
536
+ <thead>
537
+ <tr>
538
+
539
+ <th>Name</th>
540
+
541
+
542
+ <th>Type</th>
543
+
544
+
545
+ <th>Attributes</th>
546
+
547
+
548
+
549
+
550
+ <th class="last">Description</th>
551
+ </tr>
552
+ </thead>
553
+
554
+ <tbody>
555
+
556
+
557
+
558
+ <tr class="deep-level-0">
559
+
560
+ <td class="name"><code>functionName</code></td>
561
+
562
+
563
+ <td class="type">
564
+
565
+
566
+ <code class="param-type">string</code>
567
+
568
+
569
+
570
+ </td>
571
+
572
+
573
+ <td class="attributes">
574
+
575
+ &lt;optional><br>
576
+
577
+
578
+
579
+
580
+
581
+ </td>
582
+
583
+
584
+
585
+
586
+ <td class="description last">Optional function name to log.</td>
587
+ </tr>
588
+
589
+
590
+
591
+ </tbody>
592
+ </table>
593
+ </div>
594
+
595
+
596
+
597
+
598
+
599
+ <dl class="details">
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+ <p class="tag-source">
632
+ <a href="simple-logger.ts.html" class="button">View Source</a>
633
+ <span>
634
+ <a href="simple-logger.ts.html">simple-logger.ts</a>, <a href="simple-logger.ts.html#line204">line 204</a>
635
+ </span>
636
+ </p>
637
+
638
+ </dl>
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+ </div>
661
+
662
+ <div class="member">
663
+
664
+
665
+
666
+ <h4 class="name" id="setExternalLogger">
667
+ <a class="href-link" href="#setExternalLogger">#</a>
668
+
669
+ <span class="code-name">
670
+
671
+ setExternalLogger<span class="signature">(logger)</span><span class="type-signature"></span>
672
+
673
+ </span>
674
+ </h4>
675
+
676
+
677
+
678
+
679
+ <div class="description">
680
+ Sets an external logger to be used.
681
+ </div>
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+ <h5>Parameters:</h5>
693
+
694
+ <div class="table-container">
695
+ <table class="params table">
696
+ <thead>
697
+ <tr>
698
+
699
+ <th>Name</th>
700
+
701
+
702
+ <th>Type</th>
703
+
704
+
705
+
706
+
707
+
708
+ <th class="last">Description</th>
709
+ </tr>
710
+ </thead>
711
+
712
+ <tbody>
713
+
714
+
715
+
716
+ <tr class="deep-level-0">
717
+
718
+ <td class="name"><code>logger</code></td>
719
+
720
+
721
+ <td class="type">
722
+
723
+
724
+ <code class="param-type">ExternalLogger</code>
725
+ |
726
+
727
+ <code class="param-type">undefined</code>
728
+ |
729
+
730
+ <code class="param-type">null</code>
731
+
732
+
733
+
734
+ </td>
735
+
736
+
737
+
738
+
739
+
740
+ <td class="description last">The external logger to set.</td>
741
+ </tr>
742
+
743
+
744
+
745
+ </tbody>
746
+ </table>
747
+ </div>
748
+
749
+
750
+
751
+
752
+
753
+ <dl class="details">
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+ <p class="tag-source">
786
+ <a href="simple-logger.ts.html" class="button">View Source</a>
787
+ <span>
788
+ <a href="simple-logger.ts.html">simple-logger.ts</a>, <a href="simple-logger.ts.html#line197">line 197</a>
789
+ </span>
790
+ </p>
791
+
792
+ </dl>
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+ </div>
815
+
816
+ <div class="member">
817
+
818
+
819
+
820
+ <h4 class="name" id="setLevel">
821
+ <a class="href-link" href="#setLevel">#</a>
822
+
823
+ <span class="code-name">
824
+
825
+ setLevel<span class="signature">(level)</span><span class="type-signature"></span>
826
+
827
+ </span>
828
+ </h4>
829
+
830
+
831
+
832
+
833
+ <div class="description">
834
+ Sets the logging level.
835
+ </div>
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+ <h5>Parameters:</h5>
847
+
848
+ <div class="table-container">
849
+ <table class="params table">
850
+ <thead>
851
+ <tr>
852
+
853
+ <th>Name</th>
854
+
855
+
856
+ <th>Type</th>
857
+
858
+
859
+
860
+
861
+
862
+ <th class="last">Description</th>
863
+ </tr>
864
+ </thead>
865
+
866
+ <tbody>
867
+
868
+
869
+
870
+ <tr class="deep-level-0">
871
+
872
+ <td class="name"><code>level</code></td>
873
+
874
+
875
+ <td class="type">
876
+
877
+
878
+ <code class="param-type">string</code>
879
+
880
+
881
+
882
+ </td>
883
+
884
+
885
+
886
+
887
+
888
+ <td class="description last">The logging level to set.</td>
889
+ </tr>
890
+
891
+
892
+
893
+ </tbody>
894
+ </table>
895
+ </div>
896
+
897
+
898
+
899
+
900
+
901
+ <dl class="details">
902
+
903
+
904
+
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+ <p class="tag-source">
934
+ <a href="simple-logger.ts.html" class="button">View Source</a>
935
+ <span>
936
+ <a href="simple-logger.ts.html">simple-logger.ts</a>, <a href="simple-logger.ts.html#line190">line 190</a>
937
+ </span>
938
+ </p>
939
+
940
+ </dl>
941
+
942
+
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+ </div>
963
+
964
+ </div>
965
+ </div>
966
+
967
+
968
+
969
+
970
+
971
+ </article>
972
+
973
+ </section>
974
+
975
+
976
+
977
+
978
+ </div>
979
+
980
+ <footer class="footer">
981
+ <div class="content has-text-centered">
982
+ <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a></p>
983
+ <p class="sidebar-created-by">
984
+ <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
985
+ <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
986
+ </p>
987
+ </div>
988
+ </footer>
989
+
990
+ </div>
991
+ <div id="side-nav" class="side-nav">
992
+ </div>
993
+ </div>
994
+ <script src="scripts/app.min.js"></script>
995
+ <script>PR.prettyPrint();</script>
996
+ <script src="scripts/linenumber.js"> </script>
997
+
998
+
999
+ </body>
1000
+ </html>