@qubit-ltd/logging 1.4.4

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.
Files changed (54) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +224 -0
  3. package/README.zh_CN.md +200 -0
  4. package/dist/logging.cjs +1338 -0
  5. package/dist/logging.cjs.map +1 -0
  6. package/dist/logging.iife.js +1342 -0
  7. package/dist/logging.iife.js.map +1 -0
  8. package/dist/logging.min.cjs +1 -0
  9. package/dist/logging.min.cjs.map +1 -0
  10. package/dist/logging.min.iife.js +1 -0
  11. package/dist/logging.min.iife.js.map +1 -0
  12. package/dist/logging.min.mjs +1 -0
  13. package/dist/logging.min.mjs.map +1 -0
  14. package/dist/logging.mjs +1330 -0
  15. package/dist/logging.mjs.map +1 -0
  16. package/doc/api/Logger.html +3352 -0
  17. package/doc/api/fonts/OpenSans-Bold-webfont.eot +0 -0
  18. package/doc/api/fonts/OpenSans-Bold-webfont.svg +1838 -0
  19. package/doc/api/fonts/OpenSans-Bold-webfont.woff +0 -0
  20. package/doc/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  21. package/doc/api/fonts/OpenSans-BoldItalic-webfont.svg +1838 -0
  22. package/doc/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  23. package/doc/api/fonts/OpenSans-Italic-webfont.eot +0 -0
  24. package/doc/api/fonts/OpenSans-Italic-webfont.svg +1838 -0
  25. package/doc/api/fonts/OpenSans-Italic-webfont.woff +0 -0
  26. package/doc/api/fonts/OpenSans-Light-webfont.eot +0 -0
  27. package/doc/api/fonts/OpenSans-Light-webfont.svg +1839 -0
  28. package/doc/api/fonts/OpenSans-Light-webfont.woff +0 -0
  29. package/doc/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  30. package/doc/api/fonts/OpenSans-LightItalic-webfont.svg +1843 -0
  31. package/doc/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  32. package/doc/api/fonts/OpenSans-Regular-webfont.eot +0 -0
  33. package/doc/api/fonts/OpenSans-Regular-webfont.svg +1839 -0
  34. package/doc/api/fonts/OpenSans-Regular-webfont.woff +0 -0
  35. package/doc/api/fonts/OpenSans-Semibold-webfont.eot +0 -0
  36. package/doc/api/fonts/OpenSans-Semibold-webfont.svg +1838 -0
  37. package/doc/api/fonts/OpenSans-Semibold-webfont.ttf +0 -0
  38. package/doc/api/fonts/OpenSans-Semibold-webfont.woff +0 -0
  39. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
  40. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.svg +1838 -0
  41. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
  42. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
  43. package/doc/api/global.html +787 -0
  44. package/doc/api/index.html +257 -0
  45. package/doc/api/scripts/linenumber.js +34 -0
  46. package/doc/api/scripts/prettify/Apache-License-2.0.txt +202 -0
  47. package/doc/api/scripts/prettify/lang-css.js +2 -0
  48. package/doc/api/scripts/prettify/prettify.js +28 -0
  49. package/doc/api/styles/jsdoc-default.css +699 -0
  50. package/doc/api/styles/prettify-jsdoc.css +120 -0
  51. package/doc/api/styles/prettify-tomorrow.css +141 -0
  52. package/doc/logging.min.visualization.html +4949 -0
  53. package/doc/logging.visualization.html +4949 -0
  54. package/package.json +103 -0
@@ -0,0 +1,3352 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <title>Logger - Documentation</title>
7
+
8
+ <script src="scripts/prettify/prettify.js"></script>
9
+ <script src="scripts/prettify/lang-css.js"></script>
10
+ <!--[if lt IE 9]>
11
+ <script src="https://cdn.bootcdn.net/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12
+ <![endif]-->
13
+ <link type="text/css" rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/ionicons/2.0.1/css/ionicons.min.css">
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16
+ </head>
17
+ <body>
18
+
19
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
20
+ <label for="nav-trigger" class="navicon-button x">
21
+ <div class="navicon"></div>
22
+ </label>
23
+
24
+ <label for="nav-trigger" class="overlay"></label>
25
+
26
+ <nav>
27
+ <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Logger.html">Logger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#disable">disable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#enable">enable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#getAppender">getAppender</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#getLevel">getLevel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#getName">getName</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#log">log</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#setAppender">setAppender</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#setEnabled">setEnabled</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#setLevel">setLevel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.clearAllLoggers">clearAllLoggers</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.getDefaultAppender">getDefaultAppender</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.getDefaultLevel">getDefaultLevel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.getLogger">getLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.getLoggerLevel">getLoggerLevel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.reset">reset</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.resetAllAppenders">resetAllAppenders</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.resetAllLevels">resetAllLevels</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.resetDefaultAppender">resetDefaultAppender</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.resetDefaultLevel">resetDefaultLevel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.setAllAppenders">setAllAppenders</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.setAllLevels">setAllLevels</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.setDefaultAppender">setDefaultAppender</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.setDefaultLevel">setDefaultLevel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Logger.html#.setLoggerLevel">setLoggerLevel</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#FACTORY_DEFAULT_APPENDER">FACTORY_DEFAULT_APPENDER</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#FACTORY_DEFAULT_LEVEL">FACTORY_DEFAULT_LEVEL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#HasLogger">HasLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#LOGGING_LEVELS">LOGGING_LEVELS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Log">Log</a></span></li>
28
+ </nav>
29
+
30
+ <div id="main">
31
+
32
+ <h1 class="page-title">Logger</h1>
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+ <section>
41
+
42
+ <header>
43
+
44
+ <h2>
45
+ Logger
46
+ </h2>
47
+
48
+ <div class="class-description"><p>A simple logging class.</p>
49
+ <p>A <code>Logger</code> object provides the following logging methods:</p>
50
+ <ul>
51
+ <li><code>Logger.trace(message, arg1, arg2, ...)</code>: Outputs a log message with the <code>TRACE</code> level.</li>
52
+ <li><code>Logger.debug(message, arg1, arg2, ...)</code>: Outputs a log message with the <code>DEBUG</code> level.</li>
53
+ <li><code>Logger.info(message, arg1, arg2, ...)</code>: Outputs a log message with the <code>INFO</code> level.</li>
54
+ <li><code>Logger.warn(message, arg1, arg2, ...)</code>: Outputs a log message with the <code>WARN</code> level.</li>
55
+ <li><code>Logger.error(message, arg1, arg2, ...)</code>: Outputs a log message with the <code>ERROR</code> level.</li>
56
+ <li><code>Logger.log(level, message, arg1, arg2, ...)</code>: Outputs a log message with the specified level.</li>
57
+ </ul>
58
+ <p>The message argument of those logging methods supports the following
59
+ substitution patterns:</p>
60
+ <ul>
61
+ <li><code>%o</code> or <code>%O</code>: Outputs a JavaScript object. Clicking the object name opens
62
+ more information about it in the inspector.</li>
63
+ <li><code>%d</code> or <code>%i</code>: Outputs an integer. Number formatting is supported, for
64
+ example <code>logger.info('Foo %.2d', 1.1)</code> will output the number as two
65
+ significant figures with a leading 0: <code>Foo 01</code>.</li>
66
+ <li><code>%s</code>: Outputs a string.</li>
67
+ <li><code>%f</code>: Outputs a floating-point value. Formatting is supported, for example
68
+ <code>logger.debug(&quot;Foo %.2f&quot;, 1.1)</code> will output the number to 2 decimal
69
+ places: <code>Foo 1.10</code>.</li>
70
+ </ul></div>
71
+
72
+
73
+ </header>
74
+
75
+ <article>
76
+ <div class="container-overview">
77
+
78
+
79
+ <div class="section-method">
80
+
81
+
82
+ <h2>Constructor</h2>
83
+
84
+
85
+
86
+ <h4 class="name" id="Logger"><span class="type-signature"></span>new Logger<span class="signature">(name, appender, level)</span><span class="type-signature"></span></h4>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <div class="description">
94
+ <p>Construct a log object.</p>
95
+ <p><strong>NOTE</strong>: Do NOT call this constructor directly. Use the static method
96
+ <code>Logger.getLogger()</code> instead.</p>
97
+ </div>
98
+
99
+
100
+
101
+
102
+
103
+ <dl class="details">
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+ <dt class="tag-author">Author:</dt>
123
+ <dd class="tag-author">
124
+ <ul>
125
+ <li>Haixing Hu</li>
126
+ </ul>
127
+ </dd>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <dt class="tag-see">See:</dt>
142
+ <dd class="tag-see">
143
+ <ul>
144
+ <li><a href="Logger.html#.getLogger">Logger.getLogger</a></li>
145
+ </ul>
146
+ </dd>
147
+
148
+
149
+
150
+ </dl>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <h5>Parameters:</h5>
161
+
162
+
163
+ <table class="params">
164
+ <thead>
165
+ <tr>
166
+
167
+ <th>Name</th>
168
+
169
+
170
+ <th>Type</th>
171
+
172
+
173
+
174
+
175
+
176
+ <th class="last">Description</th>
177
+ </tr>
178
+ </thead>
179
+
180
+ <tbody>
181
+
182
+
183
+ <tr>
184
+
185
+ <td class="name"><code>name</code></td>
186
+
187
+
188
+ <td class="type">
189
+
190
+
191
+ <span class="param-type"><code>string</code></span>
192
+
193
+
194
+
195
+ </td>
196
+
197
+
198
+
199
+
200
+
201
+ <td class="description last">
202
+ <p>The optional name of this logger. The default value of this argument
203
+ is an empty string.</p>
204
+
205
+ </td>
206
+ </tr>
207
+
208
+
209
+
210
+ <tr>
211
+
212
+ <td class="name"><code>appender</code></td>
213
+
214
+
215
+ <td class="type">
216
+
217
+
218
+ <span class="param-type"><code>object</code></span>
219
+
220
+
221
+
222
+ </td>
223
+
224
+
225
+
226
+
227
+
228
+ <td class="description last">
229
+ <p>Optional, indicating the content output pipe of the log. This object
230
+ must provide <code>trace</code>, <code>debug</code>, <code>info</code>, <code>warn</code> and <code>error</code> methods.
231
+ The default value of this argument is <code>Logger.getDefaultAppender()</code>.</p>
232
+
233
+ </td>
234
+ </tr>
235
+
236
+
237
+
238
+ <tr>
239
+
240
+ <td class="name"><code>level</code></td>
241
+
242
+
243
+ <td class="type">
244
+
245
+
246
+ <span class="param-type"><code>string</code></span>
247
+
248
+
249
+
250
+ </td>
251
+
252
+
253
+
254
+
255
+
256
+ <td class="description last">
257
+ <p>Optional, indicating the log level of this object. The default value
258
+ of this argument is <code>Logger.getDefaultLevel()</code>.</p>
259
+
260
+ </td>
261
+ </tr>
262
+
263
+
264
+ </tbody>
265
+ </table>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+ </div>
287
+
288
+ </div>
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+ <h3 class="subsection-title">Methods</h3>
304
+
305
+
306
+
307
+ <div class="section-method">
308
+
309
+
310
+
311
+
312
+ <h4 class="name" id="disable"><span class="type-signature"></span>disable<span class="signature">()</span><span class="type-signature"></span></h4>
313
+
314
+
315
+
316
+
317
+
318
+
319
+ <div class="description">
320
+ <p>Disable this logging object.</p>
321
+ </div>
322
+
323
+
324
+
325
+
326
+
327
+ <dl class="details">
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+ </dl>
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ </div>
389
+
390
+
391
+ <div class="section-method">
392
+
393
+
394
+
395
+
396
+ <h4 class="name" id="enable"><span class="type-signature"></span>enable<span class="signature">()</span><span class="type-signature"></span></h4>
397
+
398
+
399
+
400
+
401
+
402
+
403
+ <div class="description">
404
+ <p>Enable this logging object.</p>
405
+ </div>
406
+
407
+
408
+
409
+
410
+
411
+ <dl class="details">
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+ </dl>
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
+
472
+ </div>
473
+
474
+
475
+ <div class="section-method">
476
+
477
+
478
+
479
+
480
+ <h4 class="name" id="getAppender"><span class="type-signature"></span>getAppender<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <div class="description">
488
+ <p>Get the appender of this logger.</p>
489
+ </div>
490
+
491
+
492
+
493
+
494
+
495
+ <dl class="details">
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+ </dl>
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+ <div class="section-returns">
553
+ <h5>Returns:</h5>
554
+
555
+
556
+
557
+ <dl class="param-type">
558
+ <dt>
559
+ Type:
560
+ </dt>
561
+ <dd>
562
+
563
+ <span class="param-type"><code>object</code></span>
564
+
565
+
566
+ </dd>
567
+ </dl>
568
+
569
+
570
+ <div class="param-desc">
571
+ <p>The appender of this logger.</p>
572
+ </div>
573
+
574
+
575
+ </div>
576
+
577
+
578
+
579
+
580
+
581
+ </div>
582
+
583
+
584
+ <div class="section-method">
585
+
586
+
587
+
588
+
589
+ <h4 class="name" id="getLevel"><span class="type-signature"></span>getLevel<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
590
+
591
+
592
+
593
+
594
+
595
+
596
+ <div class="description">
597
+ <p>Get the logging level of this logger.</p>
598
+ </div>
599
+
600
+
601
+
602
+
603
+
604
+ <dl class="details">
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
+
632
+
633
+
634
+
635
+
636
+
637
+ </dl>
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+ <div class="section-returns">
662
+ <h5>Returns:</h5>
663
+
664
+
665
+
666
+ <dl class="param-type">
667
+ <dt>
668
+ Type:
669
+ </dt>
670
+ <dd>
671
+
672
+ <span class="param-type"><code>string</code></span>
673
+
674
+
675
+ </dd>
676
+ </dl>
677
+
678
+
679
+ <div class="param-desc">
680
+ <p>The logging level of this logger. Possible return values are <code>TRACE</code>,
681
+ <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>, and <code>NONE</code>.</p>
682
+ </div>
683
+
684
+
685
+ </div>
686
+
687
+
688
+
689
+
690
+
691
+ </div>
692
+
693
+
694
+ <div class="section-method">
695
+
696
+
697
+
698
+
699
+ <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
700
+
701
+
702
+
703
+
704
+
705
+
706
+ <div class="description">
707
+ <p>Get the name of this logger.</p>
708
+ </div>
709
+
710
+
711
+
712
+
713
+
714
+ <dl class="details">
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+ </dl>
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+ <div class="section-returns">
772
+ <h5>Returns:</h5>
773
+
774
+
775
+
776
+ <dl class="param-type">
777
+ <dt>
778
+ Type:
779
+ </dt>
780
+ <dd>
781
+
782
+ <span class="param-type"><code>string</code></span>
783
+
784
+
785
+ </dd>
786
+ </dl>
787
+
788
+
789
+ <div class="param-desc">
790
+ <p>The name of this logger.</p>
791
+ </div>
792
+
793
+
794
+ </div>
795
+
796
+
797
+
798
+
799
+
800
+ </div>
801
+
802
+
803
+ <div class="section-method">
804
+
805
+
806
+
807
+
808
+ <h4 class="name" id="log"><span class="type-signature"></span>log<span class="signature">(level, message, &hellip;args)</span><span class="type-signature"></span></h4>
809
+
810
+
811
+
812
+
813
+
814
+
815
+ <div class="description">
816
+ <p>Logs a message in the specified logging level.</p>
817
+ </div>
818
+
819
+
820
+
821
+
822
+
823
+ <dl class="details">
824
+
825
+
826
+
827
+
828
+
829
+
830
+
831
+
832
+
833
+
834
+
835
+
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+
850
+
851
+
852
+
853
+
854
+
855
+
856
+ </dl>
857
+
858
+
859
+
860
+
861
+
862
+
863
+
864
+
865
+
866
+ <h5>Parameters:</h5>
867
+
868
+
869
+ <table class="params">
870
+ <thead>
871
+ <tr>
872
+
873
+ <th>Name</th>
874
+
875
+
876
+ <th>Type</th>
877
+
878
+
879
+ <th>Attributes</th>
880
+
881
+
882
+
883
+
884
+ <th class="last">Description</th>
885
+ </tr>
886
+ </thead>
887
+
888
+ <tbody>
889
+
890
+
891
+ <tr>
892
+
893
+ <td class="name"><code>level</code></td>
894
+
895
+
896
+ <td class="type">
897
+
898
+
899
+ <span class="param-type"><code>string</code></span>
900
+
901
+
902
+
903
+ </td>
904
+
905
+
906
+ <td class="attributes">
907
+
908
+
909
+
910
+
911
+
912
+ </td>
913
+
914
+
915
+
916
+
917
+ <td class="description last">
918
+ <p>the logging level.</p>
919
+
920
+ </td>
921
+ </tr>
922
+
923
+
924
+
925
+ <tr>
926
+
927
+ <td class="name"><code>message</code></td>
928
+
929
+
930
+ <td class="type">
931
+
932
+
933
+ <span class="param-type"><code>string</code></span>
934
+
935
+
936
+
937
+ </td>
938
+
939
+
940
+ <td class="attributes">
941
+
942
+
943
+
944
+
945
+
946
+ </td>
947
+
948
+
949
+
950
+
951
+ <td class="description last">
952
+ <p>the message or message template, which may contain zero or more
953
+ substitution patterns, e.g., '%o', '%s', '%d', '%f', ..., etc.</p>
954
+
955
+ </td>
956
+ </tr>
957
+
958
+
959
+
960
+ <tr>
961
+
962
+ <td class="name"><code>args</code></td>
963
+
964
+
965
+ <td class="type">
966
+
967
+
968
+ <span class="param-type"><code>array</code></span>
969
+
970
+
971
+
972
+ </td>
973
+
974
+
975
+ <td class="attributes">
976
+
977
+
978
+
979
+
980
+
981
+ &lt;repeatable><br>
982
+
983
+ </td>
984
+
985
+
986
+
987
+
988
+ <td class="description last">
989
+ <p>the array of arguments used to format the message.</p>
990
+
991
+ </td>
992
+ </tr>
993
+
994
+
995
+ </tbody>
996
+ </table>
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+ </div>
1018
+
1019
+
1020
+ <div class="section-method">
1021
+
1022
+
1023
+
1024
+
1025
+ <h4 class="name" id="setAppender"><span class="type-signature"></span>setAppender<span class="signature">(appender)</span><span class="type-signature"></span></h4>
1026
+
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+ <div class="description">
1033
+ <p>Set up a new Appender.</p>
1034
+ </div>
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+ <dl class="details">
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+ </dl>
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+
1083
+ <h5>Parameters:</h5>
1084
+
1085
+
1086
+ <table class="params">
1087
+ <thead>
1088
+ <tr>
1089
+
1090
+ <th>Name</th>
1091
+
1092
+
1093
+ <th>Type</th>
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+ <th class="last">Description</th>
1100
+ </tr>
1101
+ </thead>
1102
+
1103
+ <tbody>
1104
+
1105
+
1106
+ <tr>
1107
+
1108
+ <td class="name"><code>appender</code></td>
1109
+
1110
+
1111
+ <td class="type">
1112
+
1113
+
1114
+ <span class="param-type"><code>object</code></span>
1115
+
1116
+
1117
+
1118
+ </td>
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+ <td class="description last">
1125
+ <p>The new Appender serves as the content output pipeline of the log.
1126
+ This object must provide <code>trace</code>, <code>debug</code>, <code>info</code>, <code>warn</code> and <code>error</code>
1127
+ methods.</p>
1128
+
1129
+ </td>
1130
+ </tr>
1131
+
1132
+
1133
+ </tbody>
1134
+ </table>
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+ </div>
1156
+
1157
+
1158
+ <div class="section-method">
1159
+
1160
+
1161
+
1162
+
1163
+ <h4 class="name" id="setEnabled"><span class="type-signature"></span>setEnabled<span class="signature">(enabled)</span><span class="type-signature"></span></h4>
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+ <div class="description">
1171
+ <p>Enable or disable this log object.</p>
1172
+ </div>
1173
+
1174
+
1175
+
1176
+
1177
+
1178
+ <dl class="details">
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+ </dl>
1212
+
1213
+
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+
1220
+
1221
+ <h5>Parameters:</h5>
1222
+
1223
+
1224
+ <table class="params">
1225
+ <thead>
1226
+ <tr>
1227
+
1228
+ <th>Name</th>
1229
+
1230
+
1231
+ <th>Type</th>
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+ <th class="last">Description</th>
1238
+ </tr>
1239
+ </thead>
1240
+
1241
+ <tbody>
1242
+
1243
+
1244
+ <tr>
1245
+
1246
+ <td class="name"><code>enabled</code></td>
1247
+
1248
+
1249
+ <td class="type">
1250
+
1251
+
1252
+ <span class="param-type"><code>boolean</code></span>
1253
+
1254
+
1255
+
1256
+ </td>
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+ <td class="description last">
1263
+ <p>Whether to enable this log object.</p>
1264
+
1265
+ </td>
1266
+ </tr>
1267
+
1268
+
1269
+ </tbody>
1270
+ </table>
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+
1291
+ </div>
1292
+
1293
+
1294
+ <div class="section-method">
1295
+
1296
+
1297
+
1298
+
1299
+ <h4 class="name" id="setLevel"><span class="type-signature"></span>setLevel<span class="signature">(level)</span><span class="type-signature"></span></h4>
1300
+
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+ <div class="description">
1307
+ <p>Set the logging level of this logger.</p>
1308
+ </div>
1309
+
1310
+
1311
+
1312
+
1313
+
1314
+ <dl class="details">
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+ </dl>
1348
+
1349
+
1350
+
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+ <h5>Parameters:</h5>
1358
+
1359
+
1360
+ <table class="params">
1361
+ <thead>
1362
+ <tr>
1363
+
1364
+ <th>Name</th>
1365
+
1366
+
1367
+ <th>Type</th>
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+ <th class="last">Description</th>
1374
+ </tr>
1375
+ </thead>
1376
+
1377
+ <tbody>
1378
+
1379
+
1380
+ <tr>
1381
+
1382
+ <td class="name"><code>level</code></td>
1383
+
1384
+
1385
+ <td class="type">
1386
+
1387
+
1388
+ <span class="param-type"><code>string</code></span>
1389
+
1390
+
1391
+
1392
+ </td>
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+ <td class="description last">
1399
+ <p>The new logging level. The allowed levels are <code>TRACE</code>, <code>DEBUG</code>, <code>INFO</code>,
1400
+ <code>WARN</code>, <code>ERROR</code>, and <code>NONE</code>. Lowercase letters are also allowed.</p>
1401
+
1402
+ </td>
1403
+ </tr>
1404
+
1405
+
1406
+ </tbody>
1407
+ </table>
1408
+
1409
+
1410
+
1411
+
1412
+
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+
1427
+
1428
+ </div>
1429
+
1430
+
1431
+ <div class="section-method">
1432
+
1433
+
1434
+
1435
+
1436
+ <h4 class="name" id=".clearAllLoggers"><span class="type-signature">(static) </span>clearAllLoggers<span class="signature">()</span><span class="type-signature"></span></h4>
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+ <div class="description">
1444
+ <p>Clears all existing <code>Logger</code> instances.</p>
1445
+ </div>
1446
+
1447
+
1448
+
1449
+
1450
+
1451
+ <dl class="details">
1452
+
1453
+
1454
+
1455
+
1456
+
1457
+
1458
+
1459
+
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+
1468
+
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+ </dl>
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+ </div>
1513
+
1514
+
1515
+ <div class="section-method">
1516
+
1517
+
1518
+
1519
+
1520
+ <h4 class="name" id=".getDefaultAppender"><span class="type-signature">(static) </span>getDefaultAppender<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+ <div class="description">
1528
+ <p>Gets the default logging appender.</p>
1529
+ <p>The default logging appender is used to construct a new <code>Logger</code> instance
1530
+ if the logging appender of the new instance is not specified.</p>
1531
+ </div>
1532
+
1533
+
1534
+
1535
+
1536
+
1537
+ <dl class="details">
1538
+
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+
1564
+
1565
+
1566
+
1567
+
1568
+ <dt class="tag-see">See:</dt>
1569
+ <dd class="tag-see">
1570
+ <ul>
1571
+ <li><a href="Logger.html#.setDefaultAppender">Logger.setDefaultAppender</a></li>
1572
+
1573
+ <li><a href="Logger.html#.setAllAppenders">Logger.setAllAppenders</a></li>
1574
+
1575
+ <li><a href="Logger.html#.resetAllAppenders">Logger.resetAllAppenders</a></li>
1576
+ </ul>
1577
+ </dd>
1578
+
1579
+
1580
+
1581
+ </dl>
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+
1591
+
1592
+
1593
+
1594
+
1595
+
1596
+
1597
+
1598
+
1599
+
1600
+
1601
+
1602
+
1603
+
1604
+
1605
+ <div class="section-returns">
1606
+ <h5>Returns:</h5>
1607
+
1608
+
1609
+
1610
+ <dl class="param-type">
1611
+ <dt>
1612
+ Type:
1613
+ </dt>
1614
+ <dd>
1615
+
1616
+ <span class="param-type"><code>Object</code></span>
1617
+
1618
+
1619
+ </dd>
1620
+ </dl>
1621
+
1622
+
1623
+ <div class="param-desc">
1624
+ <p>The default logging appender.</p>
1625
+ </div>
1626
+
1627
+
1628
+ </div>
1629
+
1630
+
1631
+
1632
+
1633
+
1634
+ </div>
1635
+
1636
+
1637
+ <div class="section-method">
1638
+
1639
+
1640
+
1641
+
1642
+ <h4 class="name" id=".getDefaultLevel"><span class="type-signature">(static) </span>getDefaultLevel<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1643
+
1644
+
1645
+
1646
+
1647
+
1648
+
1649
+ <div class="description">
1650
+ <p>Gets the default logging level.</p>
1651
+ <p>The default logging level is used to construct a new <code>Logger</code> instance if
1652
+ the logging level of the new instance is not specified.</p>
1653
+ </div>
1654
+
1655
+
1656
+
1657
+
1658
+
1659
+ <dl class="details">
1660
+
1661
+
1662
+
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+
1672
+
1673
+
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+
1683
+
1684
+
1685
+
1686
+
1687
+
1688
+
1689
+
1690
+ <dt class="tag-see">See:</dt>
1691
+ <dd class="tag-see">
1692
+ <ul>
1693
+ <li><a href="Logger.html#.setDefaultLevel">Logger.setDefaultLevel</a></li>
1694
+
1695
+ <li><a href="Logger.html#.setAllLevels">Logger.setAllLevels</a></li>
1696
+
1697
+ <li><a href="Logger.html#.resetAllLevels">Logger.resetAllLevels</a></li>
1698
+ </ul>
1699
+ </dd>
1700
+
1701
+
1702
+
1703
+ </dl>
1704
+
1705
+
1706
+
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+ <div class="section-returns">
1728
+ <h5>Returns:</h5>
1729
+
1730
+
1731
+
1732
+ <dl class="param-type">
1733
+ <dt>
1734
+ Type:
1735
+ </dt>
1736
+ <dd>
1737
+
1738
+ <span class="param-type"><code>string</code></span>
1739
+
1740
+
1741
+ </dd>
1742
+ </dl>
1743
+
1744
+
1745
+ <div class="param-desc">
1746
+ <p>The global default logging level.</p>
1747
+ </div>
1748
+
1749
+
1750
+ </div>
1751
+
1752
+
1753
+
1754
+
1755
+
1756
+ </div>
1757
+
1758
+
1759
+ <div class="section-method">
1760
+
1761
+
1762
+
1763
+
1764
+ <h4 class="name" id=".getLogger"><span class="type-signature">(static) </span>getLogger<span class="signature">(name, options)</span><span class="type-signature"> &rarr; {<a href="Logger.html">Logger</a>}</span></h4>
1765
+
1766
+
1767
+
1768
+
1769
+
1770
+
1771
+ <div class="description">
1772
+ <p>Gets the <code>Logger</code> instance of the specified name, or constructs a new
1773
+ <code>Logger</code> instance if it does not exist.</p>
1774
+ </div>
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+ <dl class="details">
1781
+
1782
+
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+
1791
+
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+
1809
+
1810
+
1811
+
1812
+
1813
+ </dl>
1814
+
1815
+
1816
+
1817
+
1818
+
1819
+
1820
+
1821
+
1822
+
1823
+ <h5>Parameters:</h5>
1824
+
1825
+
1826
+ <table class="params">
1827
+ <thead>
1828
+ <tr>
1829
+
1830
+ <th>Name</th>
1831
+
1832
+
1833
+ <th>Type</th>
1834
+
1835
+
1836
+
1837
+
1838
+
1839
+ <th class="last">Description</th>
1840
+ </tr>
1841
+ </thead>
1842
+
1843
+ <tbody>
1844
+
1845
+
1846
+ <tr>
1847
+
1848
+ <td class="name"><code>name</code></td>
1849
+
1850
+
1851
+ <td class="type">
1852
+
1853
+
1854
+ <span class="param-type"><code>string</code></span>
1855
+
1856
+
1857
+
1858
+ </td>
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+ <td class="description last">
1865
+ <p>The name of the <code>Logger</code> instance to be retrieved.</p>
1866
+
1867
+ </td>
1868
+ </tr>
1869
+
1870
+
1871
+
1872
+ <tr>
1873
+
1874
+ <td class="name"><code>options</code></td>
1875
+
1876
+
1877
+ <td class="type">
1878
+
1879
+
1880
+ <span class="param-type"><code>Object</code></span>
1881
+
1882
+
1883
+
1884
+ </td>
1885
+
1886
+
1887
+
1888
+
1889
+
1890
+ <td class="description last">
1891
+ <p>The optional options of the <code>Logger</code> instance to be retrieved. This
1892
+ option object may have the following properties:
1893
+ - <code>appender: object</code>: the specified content output pipe of the log.
1894
+ This object must provide <code>trace</code>, <code>debug</code>, <code>info</code>, <code>warn</code> and <code>error</code>
1895
+ methods. If this option is not provided, the appender of the existing
1896
+ <code>Logger</code> instance will not be changed, and the default appender
1897
+ will be used to construct a new <code>Logger</code> instance if it does not exist.
1898
+ - <code>level: string</code>: the logging level of the <code>Logger</code> instance to be
1899
+ retrieved. The allowed levels are <code>TRACE</code>, <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>,
1900
+ <code>ERROR</code>, and <code>NONE</code>. Lowercase letters are also allowed. If this
1901
+ option is not provided, the logging level of the existing <code>Logger</code>
1902
+ instance will not be changed, and the default logging level will be
1903
+ used to construct a new <code>Logger</code> instance if it does not exist.</p>
1904
+
1905
+ </td>
1906
+ </tr>
1907
+
1908
+
1909
+ </tbody>
1910
+ </table>
1911
+
1912
+
1913
+
1914
+
1915
+
1916
+
1917
+
1918
+
1919
+
1920
+
1921
+
1922
+
1923
+
1924
+
1925
+
1926
+
1927
+ <div class="section-returns">
1928
+ <h5>Returns:</h5>
1929
+
1930
+
1931
+
1932
+ <dl class="param-type">
1933
+ <dt>
1934
+ Type:
1935
+ </dt>
1936
+ <dd>
1937
+
1938
+ <span class="param-type"><code><a href="Logger.html">Logger</a></code></span>
1939
+
1940
+
1941
+ </dd>
1942
+ </dl>
1943
+
1944
+
1945
+ <div class="param-desc">
1946
+ <p>The <code>Logger</code> instance of the specified name, which either be the
1947
+ existing one or a newly constructed one.</p>
1948
+ </div>
1949
+
1950
+
1951
+ </div>
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+ </div>
1958
+
1959
+
1960
+ <div class="section-method">
1961
+
1962
+
1963
+
1964
+
1965
+ <h4 class="name" id=".getLoggerLevel"><span class="type-signature">(static) </span>getLoggerLevel<span class="signature">(name)</span><span class="type-signature"> &rarr; {string}</span></h4>
1966
+
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+ <div class="description">
1973
+ <p>Gets the logging level of the <code>Logger</code> instance of the specified name.</p>
1974
+ </div>
1975
+
1976
+
1977
+
1978
+
1979
+
1980
+ <dl class="details">
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+ </dl>
2014
+
2015
+
2016
+
2017
+
2018
+
2019
+
2020
+
2021
+
2022
+
2023
+ <h5>Parameters:</h5>
2024
+
2025
+
2026
+ <table class="params">
2027
+ <thead>
2028
+ <tr>
2029
+
2030
+ <th>Name</th>
2031
+
2032
+
2033
+ <th>Type</th>
2034
+
2035
+
2036
+
2037
+
2038
+
2039
+ <th class="last">Description</th>
2040
+ </tr>
2041
+ </thead>
2042
+
2043
+ <tbody>
2044
+
2045
+
2046
+ <tr>
2047
+
2048
+ <td class="name"><code>name</code></td>
2049
+
2050
+
2051
+ <td class="type">
2052
+
2053
+ </td>
2054
+
2055
+
2056
+
2057
+
2058
+
2059
+ <td class="description last">
2060
+ <p>The name of the <code>Logger</code> instance.</p>
2061
+
2062
+ </td>
2063
+ </tr>
2064
+
2065
+
2066
+ </tbody>
2067
+ </table>
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+
2074
+
2075
+
2076
+
2077
+
2078
+
2079
+
2080
+
2081
+
2082
+
2083
+
2084
+ <div class="section-returns">
2085
+ <h5>Returns:</h5>
2086
+
2087
+
2088
+
2089
+ <dl class="param-type">
2090
+ <dt>
2091
+ Type:
2092
+ </dt>
2093
+ <dd>
2094
+
2095
+ <span class="param-type"><code>string</code></span>
2096
+
2097
+
2098
+ </dd>
2099
+ </dl>
2100
+
2101
+
2102
+ <div class="param-desc">
2103
+ <p>The logging level of the <code>Logger</code> instance of the specified name. If the
2104
+ <code>Logger</code> instance of the specified name does not exist, the default
2105
+ logging level will be returned.</p>
2106
+ </div>
2107
+
2108
+
2109
+ </div>
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+ </div>
2116
+
2117
+
2118
+ <div class="section-method">
2119
+
2120
+
2121
+
2122
+
2123
+ <h4 class="name" id=".reset"><span class="type-signature">(static) </span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+ <div class="description">
2131
+ <p>Resets all configurations of the <code>Logger</code> class to the factory values.</p>
2132
+ <p>This method is equivalent to calling the following methods in sequence:</p>
2133
+ <ul>
2134
+ <li><code>Logger.clearAllLoggers()</code></li>
2135
+ <li><code>Logger.resetDefaultLevel()</code></li>
2136
+ <li><code>Logger.resetDefaultAppender()</code></li>
2137
+ </ul>
2138
+ </div>
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+ <dl class="details">
2145
+
2146
+
2147
+
2148
+
2149
+
2150
+
2151
+
2152
+
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+
2165
+
2166
+
2167
+
2168
+
2169
+
2170
+
2171
+
2172
+
2173
+
2174
+
2175
+
2176
+
2177
+ </dl>
2178
+
2179
+
2180
+
2181
+
2182
+
2183
+
2184
+
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+
2191
+
2192
+
2193
+
2194
+
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+ </div>
2206
+
2207
+
2208
+ <div class="section-method">
2209
+
2210
+
2211
+
2212
+
2213
+ <h4 class="name" id=".resetAllAppenders"><span class="type-signature">(static) </span>resetAllAppenders<span class="signature">()</span><span class="type-signature"></span></h4>
2214
+
2215
+
2216
+
2217
+
2218
+
2219
+
2220
+ <div class="description">
2221
+ <p>Sets the appender of all <code>Logger</code> instants to the default appender.</p>
2222
+ </div>
2223
+
2224
+
2225
+
2226
+
2227
+
2228
+ <dl class="details">
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+
2237
+
2238
+
2239
+
2240
+
2241
+
2242
+
2243
+
2244
+
2245
+
2246
+
2247
+
2248
+
2249
+
2250
+
2251
+
2252
+
2253
+
2254
+
2255
+
2256
+
2257
+
2258
+
2259
+ <dt class="tag-see">See:</dt>
2260
+ <dd class="tag-see">
2261
+ <ul>
2262
+ <li><a href="Logger.html#.getDefaultAppender">Logger.getDefaultAppender</a></li>
2263
+
2264
+ <li><a href="Logger.html#.setDefaultAppender">Logger.setDefaultAppender</a></li>
2265
+
2266
+ <li><a href="Logger.html#.setAllAppenders">Logger.setAllAppenders</a></li>
2267
+ </ul>
2268
+ </dd>
2269
+
2270
+
2271
+
2272
+ </dl>
2273
+
2274
+
2275
+
2276
+
2277
+
2278
+
2279
+
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+
2286
+
2287
+
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+
2296
+
2297
+
2298
+
2299
+
2300
+ </div>
2301
+
2302
+
2303
+ <div class="section-method">
2304
+
2305
+
2306
+
2307
+
2308
+ <h4 class="name" id=".resetAllLevels"><span class="type-signature">(static) </span>resetAllLevels<span class="signature">()</span><span class="type-signature"></span></h4>
2309
+
2310
+
2311
+
2312
+
2313
+
2314
+
2315
+ <div class="description">
2316
+ <p>Sets the logging level of all <code>Logger</code> instants to the default logging level.</p>
2317
+ </div>
2318
+
2319
+
2320
+
2321
+
2322
+
2323
+ <dl class="details">
2324
+
2325
+
2326
+
2327
+
2328
+
2329
+
2330
+
2331
+
2332
+
2333
+
2334
+
2335
+
2336
+
2337
+
2338
+
2339
+
2340
+
2341
+
2342
+
2343
+
2344
+
2345
+
2346
+
2347
+
2348
+
2349
+
2350
+
2351
+
2352
+
2353
+
2354
+ <dt class="tag-see">See:</dt>
2355
+ <dd class="tag-see">
2356
+ <ul>
2357
+ <li><a href="Logger.html#.getDefaultLevel">Logger.getDefaultLevel</a></li>
2358
+
2359
+ <li><a href="Logger.html#.setDefaultLevel">Logger.setDefaultLevel</a></li>
2360
+
2361
+ <li><a href="Logger.html#.setAllLevels">Logger.setAllLevels</a></li>
2362
+ </ul>
2363
+ </dd>
2364
+
2365
+
2366
+
2367
+ </dl>
2368
+
2369
+
2370
+
2371
+
2372
+
2373
+
2374
+
2375
+
2376
+
2377
+
2378
+
2379
+
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+
2395
+ </div>
2396
+
2397
+
2398
+ <div class="section-method">
2399
+
2400
+
2401
+
2402
+
2403
+ <h4 class="name" id=".resetDefaultAppender"><span class="type-signature">(static) </span>resetDefaultAppender<span class="signature">()</span><span class="type-signature"></span></h4>
2404
+
2405
+
2406
+
2407
+
2408
+
2409
+
2410
+ <div class="description">
2411
+ <p>Resets the default logging appender to the factory value.</p>
2412
+ <p>The default logging appender is used to construct a new <code>Logger</code> instance
2413
+ if the logging appender of the new instance is not specified.</p>
2414
+ </div>
2415
+
2416
+
2417
+
2418
+
2419
+
2420
+ <dl class="details">
2421
+
2422
+
2423
+
2424
+
2425
+
2426
+
2427
+
2428
+
2429
+
2430
+
2431
+
2432
+
2433
+
2434
+
2435
+
2436
+
2437
+
2438
+
2439
+
2440
+
2441
+
2442
+
2443
+
2444
+
2445
+
2446
+
2447
+
2448
+
2449
+
2450
+
2451
+ <dt class="tag-see">See:</dt>
2452
+ <dd class="tag-see">
2453
+ <ul>
2454
+ <li><a href="Logger.html#.getDefaultAppender">Logger.getDefaultAppender</a></li>
2455
+ </ul>
2456
+ </dd>
2457
+
2458
+
2459
+
2460
+ </dl>
2461
+
2462
+
2463
+
2464
+
2465
+
2466
+
2467
+
2468
+
2469
+
2470
+
2471
+
2472
+
2473
+
2474
+
2475
+
2476
+
2477
+
2478
+
2479
+
2480
+
2481
+
2482
+
2483
+
2484
+
2485
+
2486
+
2487
+
2488
+ </div>
2489
+
2490
+
2491
+ <div class="section-method">
2492
+
2493
+
2494
+
2495
+
2496
+ <h4 class="name" id=".resetDefaultLevel"><span class="type-signature">(static) </span>resetDefaultLevel<span class="signature">()</span><span class="type-signature"></span></h4>
2497
+
2498
+
2499
+
2500
+
2501
+
2502
+
2503
+ <div class="description">
2504
+ <p>Resets the default logging level to the factory value.</p>
2505
+ <p>The default logging level is used to construct a new <code>Logger</code> instance if
2506
+ the logging level of the new instance is not specified.</p>
2507
+ </div>
2508
+
2509
+
2510
+
2511
+
2512
+
2513
+ <dl class="details">
2514
+
2515
+
2516
+
2517
+
2518
+
2519
+
2520
+
2521
+
2522
+
2523
+
2524
+
2525
+
2526
+
2527
+
2528
+
2529
+
2530
+
2531
+
2532
+
2533
+
2534
+
2535
+
2536
+
2537
+
2538
+
2539
+
2540
+
2541
+
2542
+
2543
+
2544
+
2545
+
2546
+ </dl>
2547
+
2548
+
2549
+
2550
+
2551
+
2552
+
2553
+
2554
+
2555
+
2556
+
2557
+
2558
+
2559
+
2560
+
2561
+
2562
+
2563
+
2564
+
2565
+
2566
+
2567
+
2568
+
2569
+
2570
+
2571
+
2572
+
2573
+
2574
+ </div>
2575
+
2576
+
2577
+ <div class="section-method">
2578
+
2579
+
2580
+
2581
+
2582
+ <h4 class="name" id=".setAllAppenders"><span class="type-signature">(static) </span>setAllAppenders<span class="signature">(appender)</span><span class="type-signature"></span></h4>
2583
+
2584
+
2585
+
2586
+
2587
+
2588
+
2589
+ <div class="description">
2590
+ <p>Sets the appender of all <code>Logger</code> instants.</p>
2591
+ </div>
2592
+
2593
+
2594
+
2595
+
2596
+
2597
+ <dl class="details">
2598
+
2599
+
2600
+
2601
+
2602
+
2603
+
2604
+
2605
+
2606
+
2607
+
2608
+
2609
+
2610
+
2611
+
2612
+
2613
+
2614
+
2615
+
2616
+
2617
+
2618
+
2619
+
2620
+
2621
+
2622
+
2623
+
2624
+
2625
+
2626
+
2627
+
2628
+ <dt class="tag-see">See:</dt>
2629
+ <dd class="tag-see">
2630
+ <ul>
2631
+ <li><a href="Logger.html#.getDefaultAppender">Logger.getDefaultAppender</a></li>
2632
+
2633
+ <li><a href="Logger.html#.setDefaultAppender">Logger.setDefaultAppender</a></li>
2634
+
2635
+ <li><a href="Logger.html#.resetAllAppenders">Logger.resetAllAppenders</a></li>
2636
+ </ul>
2637
+ </dd>
2638
+
2639
+
2640
+
2641
+ </dl>
2642
+
2643
+
2644
+
2645
+
2646
+
2647
+
2648
+
2649
+
2650
+
2651
+ <h5>Parameters:</h5>
2652
+
2653
+
2654
+ <table class="params">
2655
+ <thead>
2656
+ <tr>
2657
+
2658
+ <th>Name</th>
2659
+
2660
+
2661
+ <th>Type</th>
2662
+
2663
+
2664
+
2665
+
2666
+
2667
+ <th class="last">Description</th>
2668
+ </tr>
2669
+ </thead>
2670
+
2671
+ <tbody>
2672
+
2673
+
2674
+ <tr>
2675
+
2676
+ <td class="name"><code>appender</code></td>
2677
+
2678
+
2679
+ <td class="type">
2680
+
2681
+
2682
+ <span class="param-type"><code>object</code></span>
2683
+
2684
+
2685
+
2686
+ </td>
2687
+
2688
+
2689
+
2690
+
2691
+
2692
+ <td class="description last">
2693
+ <p>The new appender to be set, indicating the content output pipe of the
2694
+ log. This object must provide <code>trace</code>, <code>debug</code>, <code>info</code>, <code>warn</code> and
2695
+ <code>error</code> methods.</p>
2696
+
2697
+ </td>
2698
+ </tr>
2699
+
2700
+
2701
+ </tbody>
2702
+ </table>
2703
+
2704
+
2705
+
2706
+
2707
+
2708
+
2709
+
2710
+
2711
+
2712
+
2713
+
2714
+
2715
+
2716
+
2717
+
2718
+
2719
+
2720
+
2721
+
2722
+
2723
+ </div>
2724
+
2725
+
2726
+ <div class="section-method">
2727
+
2728
+
2729
+
2730
+
2731
+ <h4 class="name" id=".setAllLevels"><span class="type-signature">(static) </span>setAllLevels<span class="signature">(level)</span><span class="type-signature"></span></h4>
2732
+
2733
+
2734
+
2735
+
2736
+
2737
+
2738
+ <div class="description">
2739
+ <p>Sets the logging level of all existing <code>Logger</code> instants.</p>
2740
+ </div>
2741
+
2742
+
2743
+
2744
+
2745
+
2746
+ <dl class="details">
2747
+
2748
+
2749
+
2750
+
2751
+
2752
+
2753
+
2754
+
2755
+
2756
+
2757
+
2758
+
2759
+
2760
+
2761
+
2762
+
2763
+
2764
+
2765
+
2766
+
2767
+
2768
+
2769
+
2770
+
2771
+
2772
+
2773
+
2774
+
2775
+
2776
+
2777
+ <dt class="tag-see">See:</dt>
2778
+ <dd class="tag-see">
2779
+ <ul>
2780
+ <li><a href="Logger.html#.getDefaultLevel">Logger.getDefaultLevel</a></li>
2781
+
2782
+ <li><a href="Logger.html#.setDefaultLevel">Logger.setDefaultLevel</a></li>
2783
+
2784
+ <li><a href="Logger.html#.resetAllLevels">Logger.resetAllLevels</a></li>
2785
+ </ul>
2786
+ </dd>
2787
+
2788
+
2789
+
2790
+ </dl>
2791
+
2792
+
2793
+
2794
+
2795
+
2796
+
2797
+
2798
+
2799
+
2800
+ <h5>Parameters:</h5>
2801
+
2802
+
2803
+ <table class="params">
2804
+ <thead>
2805
+ <tr>
2806
+
2807
+ <th>Name</th>
2808
+
2809
+
2810
+ <th>Type</th>
2811
+
2812
+
2813
+
2814
+
2815
+
2816
+ <th class="last">Description</th>
2817
+ </tr>
2818
+ </thead>
2819
+
2820
+ <tbody>
2821
+
2822
+
2823
+ <tr>
2824
+
2825
+ <td class="name"><code>level</code></td>
2826
+
2827
+
2828
+ <td class="type">
2829
+
2830
+
2831
+ <span class="param-type"><code>string</code></span>
2832
+
2833
+
2834
+
2835
+ </td>
2836
+
2837
+
2838
+
2839
+
2840
+
2841
+ <td class="description last">
2842
+ <p>The new logging level of all existing <code>Logger</code> instants. The allowed
2843
+ levels are <code>TRACE</code>, <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>, and <code>NONE</code>.
2844
+ Lowercase letters are also allowed.</p>
2845
+
2846
+ </td>
2847
+ </tr>
2848
+
2849
+
2850
+ </tbody>
2851
+ </table>
2852
+
2853
+
2854
+
2855
+
2856
+
2857
+
2858
+
2859
+
2860
+
2861
+
2862
+
2863
+
2864
+
2865
+
2866
+
2867
+
2868
+
2869
+
2870
+
2871
+
2872
+ </div>
2873
+
2874
+
2875
+ <div class="section-method">
2876
+
2877
+
2878
+
2879
+
2880
+ <h4 class="name" id=".setDefaultAppender"><span class="type-signature">(static) </span>setDefaultAppender<span class="signature">(appender)</span><span class="type-signature"></span></h4>
2881
+
2882
+
2883
+
2884
+
2885
+
2886
+
2887
+ <div class="description">
2888
+ <p>Sets the default logging appender.</p>
2889
+ <p>The default logging appender is used to construct a new <code>Logger</code> instance
2890
+ if the logging appender of the new instance is not specified.</p>
2891
+ </div>
2892
+
2893
+
2894
+
2895
+
2896
+
2897
+ <dl class="details">
2898
+
2899
+
2900
+
2901
+
2902
+
2903
+
2904
+
2905
+
2906
+
2907
+
2908
+
2909
+
2910
+
2911
+
2912
+
2913
+
2914
+
2915
+
2916
+
2917
+
2918
+
2919
+
2920
+
2921
+
2922
+
2923
+
2924
+
2925
+
2926
+
2927
+
2928
+ <dt class="tag-see">See:</dt>
2929
+ <dd class="tag-see">
2930
+ <ul>
2931
+ <li><a href="Logger.html#.getDefaultAppender">Logger.getDefaultAppender</a></li>
2932
+
2933
+ <li><a href="Logger.html#.setAllAppenders">Logger.setAllAppenders</a></li>
2934
+
2935
+ <li><a href="Logger.html#.resetAllAppenders">Logger.resetAllAppenders</a></li>
2936
+ </ul>
2937
+ </dd>
2938
+
2939
+
2940
+
2941
+ </dl>
2942
+
2943
+
2944
+
2945
+
2946
+
2947
+
2948
+
2949
+
2950
+
2951
+ <h5>Parameters:</h5>
2952
+
2953
+
2954
+ <table class="params">
2955
+ <thead>
2956
+ <tr>
2957
+
2958
+ <th>Name</th>
2959
+
2960
+
2961
+ <th>Type</th>
2962
+
2963
+
2964
+
2965
+
2966
+
2967
+ <th class="last">Description</th>
2968
+ </tr>
2969
+ </thead>
2970
+
2971
+ <tbody>
2972
+
2973
+
2974
+ <tr>
2975
+
2976
+ <td class="name"><code>appender</code></td>
2977
+
2978
+
2979
+ <td class="type">
2980
+
2981
+
2982
+ <span class="param-type"><code>object</code></span>
2983
+
2984
+
2985
+
2986
+ </td>
2987
+
2988
+
2989
+
2990
+
2991
+
2992
+ <td class="description last">
2993
+ <p>The new default logging appender.</p>
2994
+
2995
+ </td>
2996
+ </tr>
2997
+
2998
+
2999
+ </tbody>
3000
+ </table>
3001
+
3002
+
3003
+
3004
+
3005
+
3006
+
3007
+
3008
+
3009
+
3010
+
3011
+
3012
+
3013
+
3014
+
3015
+
3016
+
3017
+
3018
+
3019
+
3020
+
3021
+ </div>
3022
+
3023
+
3024
+ <div class="section-method">
3025
+
3026
+
3027
+
3028
+
3029
+ <h4 class="name" id=".setDefaultLevel"><span class="type-signature">(static) </span>setDefaultLevel<span class="signature">(level)</span><span class="type-signature"></span></h4>
3030
+
3031
+
3032
+
3033
+
3034
+
3035
+
3036
+ <div class="description">
3037
+ <p>Sets the default logging level.</p>
3038
+ <p>The default logging level is used to construct a new <code>Logger</code> instance if
3039
+ the logging level of the new instance is not specified.</p>
3040
+ </div>
3041
+
3042
+
3043
+
3044
+
3045
+
3046
+ <dl class="details">
3047
+
3048
+
3049
+
3050
+
3051
+
3052
+
3053
+
3054
+
3055
+
3056
+
3057
+
3058
+
3059
+
3060
+
3061
+
3062
+
3063
+
3064
+
3065
+
3066
+
3067
+
3068
+
3069
+
3070
+
3071
+
3072
+
3073
+
3074
+
3075
+
3076
+
3077
+ <dt class="tag-see">See:</dt>
3078
+ <dd class="tag-see">
3079
+ <ul>
3080
+ <li><a href="Logger.html#.getDefaultLevel">Logger.getDefaultLevel</a></li>
3081
+
3082
+ <li><a href="Logger.html#.setAllLevels">Logger.setAllLevels</a></li>
3083
+
3084
+ <li><a href="Logger.html#.resetAllLevels">Logger.resetAllLevels</a></li>
3085
+ </ul>
3086
+ </dd>
3087
+
3088
+
3089
+
3090
+ </dl>
3091
+
3092
+
3093
+
3094
+
3095
+
3096
+
3097
+
3098
+
3099
+
3100
+ <h5>Parameters:</h5>
3101
+
3102
+
3103
+ <table class="params">
3104
+ <thead>
3105
+ <tr>
3106
+
3107
+ <th>Name</th>
3108
+
3109
+
3110
+ <th>Type</th>
3111
+
3112
+
3113
+
3114
+
3115
+
3116
+ <th class="last">Description</th>
3117
+ </tr>
3118
+ </thead>
3119
+
3120
+ <tbody>
3121
+
3122
+
3123
+ <tr>
3124
+
3125
+ <td class="name"><code>level</code></td>
3126
+
3127
+
3128
+ <td class="type">
3129
+
3130
+
3131
+ <span class="param-type"><code>string</code></span>
3132
+
3133
+
3134
+
3135
+ </td>
3136
+
3137
+
3138
+
3139
+
3140
+
3141
+ <td class="description last">
3142
+ <p>The new default logging level. The allowed levels are <code>TRACE</code>, <code>DEBUG</code>,
3143
+ <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>, and <code>NONE</code>. Lowercase letters are also allowed.</p>
3144
+
3145
+ </td>
3146
+ </tr>
3147
+
3148
+
3149
+ </tbody>
3150
+ </table>
3151
+
3152
+
3153
+
3154
+
3155
+
3156
+
3157
+
3158
+
3159
+
3160
+
3161
+
3162
+
3163
+
3164
+
3165
+
3166
+
3167
+
3168
+
3169
+
3170
+
3171
+ </div>
3172
+
3173
+
3174
+ <div class="section-method">
3175
+
3176
+
3177
+
3178
+
3179
+ <h4 class="name" id=".setLoggerLevel"><span class="type-signature">(static) </span>setLoggerLevel<span class="signature">(name, level)</span><span class="type-signature"></span></h4>
3180
+
3181
+
3182
+
3183
+
3184
+
3185
+
3186
+ <div class="description">
3187
+ <p>Sets the logging level of the <code>Logger</code> instance of the specified name.</p>
3188
+ </div>
3189
+
3190
+
3191
+
3192
+
3193
+
3194
+ <dl class="details">
3195
+
3196
+
3197
+
3198
+
3199
+
3200
+
3201
+
3202
+
3203
+
3204
+
3205
+
3206
+
3207
+
3208
+
3209
+
3210
+
3211
+
3212
+
3213
+
3214
+
3215
+
3216
+
3217
+
3218
+
3219
+
3220
+
3221
+
3222
+
3223
+
3224
+
3225
+
3226
+
3227
+ </dl>
3228
+
3229
+
3230
+
3231
+
3232
+
3233
+
3234
+
3235
+
3236
+
3237
+ <h5>Parameters:</h5>
3238
+
3239
+
3240
+ <table class="params">
3241
+ <thead>
3242
+ <tr>
3243
+
3244
+ <th>Name</th>
3245
+
3246
+
3247
+ <th>Type</th>
3248
+
3249
+
3250
+
3251
+
3252
+
3253
+ <th class="last">Description</th>
3254
+ </tr>
3255
+ </thead>
3256
+
3257
+ <tbody>
3258
+
3259
+
3260
+ <tr>
3261
+
3262
+ <td class="name"><code>name</code></td>
3263
+
3264
+
3265
+ <td class="type">
3266
+
3267
+ </td>
3268
+
3269
+
3270
+
3271
+
3272
+
3273
+ <td class="description last">
3274
+ <p>The name of the <code>Logger</code> instance.</p>
3275
+
3276
+ </td>
3277
+ </tr>
3278
+
3279
+
3280
+
3281
+ <tr>
3282
+
3283
+ <td class="name"><code>level</code></td>
3284
+
3285
+
3286
+ <td class="type">
3287
+
3288
+ </td>
3289
+
3290
+
3291
+
3292
+
3293
+
3294
+ <td class="description last">
3295
+ <p>The new logging level of the <code>Logger</code> instance of the specified name.
3296
+ The allowed levels are <code>TRACE</code>, <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>,
3297
+ and <code>NONE</code>. Lowercase letters are also allowed.</p>
3298
+
3299
+ </td>
3300
+ </tr>
3301
+
3302
+
3303
+ </tbody>
3304
+ </table>
3305
+
3306
+
3307
+
3308
+
3309
+
3310
+
3311
+
3312
+
3313
+
3314
+
3315
+
3316
+
3317
+
3318
+
3319
+
3320
+
3321
+
3322
+
3323
+
3324
+
3325
+ </div>
3326
+
3327
+
3328
+
3329
+
3330
+
3331
+
3332
+ </article>
3333
+
3334
+ </section>
3335
+
3336
+
3337
+
3338
+
3339
+ </div>
3340
+
3341
+ <br class="clear">
3342
+
3343
+ <footer>
3344
+ Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
3345
+ on Sun Jan 05 2025 14:29:26 GMT+0800 (China Standard Time)
3346
+ using the <a href="https://github.com/Haixing-Hu/jsdoc-minami">customized Minami theme</a>.
3347
+ </footer>
3348
+
3349
+ <script>prettyPrint();</script>
3350
+ <script src="scripts/linenumber.js"></script>
3351
+ </body>
3352
+ </html>