@ncfour-us/logging 0.0.24 → 0.0.26

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.
package/README.md CHANGED
@@ -24,6 +24,7 @@ This project implements a simple logger and a proxy for winston logger.
24
24
 
25
25
  - [Installation](#installation)
26
26
  - [Getting Started](#getting-started)
27
+ - [API Documentation](#api-documentation)
27
28
  - [Contributing](#contributing)
28
29
  - [License](#license)
29
30
  - [Authors](#authors)
@@ -54,6 +55,10 @@ import { ILogger, createLogger } from '@ncfour-us/logging';
54
55
  const myLogger: ILogger = createLogger('simple');
55
56
  ```
56
57
 
58
+ ## API Documentation
59
+
60
+ The API is documented at the [API documentation](./docs/api/index.md) page.
61
+
57
62
  ## Contributing
58
63
 
59
64
  Fork this repository and submit a PR.
@@ -1,29 +1,146 @@
1
+ /**
2
+ * Log level setting
3
+ */
1
4
  export type LoggerLevel = 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
5
+ /**
6
+ * Logger type for {@link createLogger} to create
7
+ */
2
8
  export type LoggerType = 'simple' | 'winston';
9
+ /**
10
+ * Options for creating/getting a logger. Used when calling `createLogger()`.
11
+ *
12
+ * @see {@link createLogger}
13
+ *
14
+ */
3
15
  export interface LoggerProps {
16
+ /**
17
+ * The name for the logger
18
+ * @default 'default' (suppressed from log records)
19
+ */
4
20
  name?: string;
21
+ /**
22
+ * The logging level to use, (default: `'error'`)
23
+ * @default 'error'
24
+ */
5
25
  level?: LoggerLevel;
26
+ /**
27
+ * Use JSON or text output (default: `true`)
28
+ * @default true
29
+ */
6
30
  json?: boolean;
31
+ /**
32
+ * Use color in text output (default: `false`)
33
+ * @default false
34
+ */
7
35
  color?: boolean;
36
+ /**
37
+ * Suppress log output, regardless of level (default: `false`)
38
+ * @default false
39
+ */
8
40
  silent?: boolean;
41
+ /**
42
+ * Include timestamps in text output (default: `true`)
43
+ * @default true
44
+ */
9
45
  timestamp?: boolean;
10
46
  }
47
+ /**
48
+ * Options for updating a logger configuration. Used when calling `ILogger.setLoggerProps()`.
49
+ * @see {@link ILogger.setLoggerProps}
50
+ */
11
51
  export interface LoggerSetLoggerProps {
52
+ /**
53
+ * The logging level to use, (default: `'error'`)
54
+ * @default 'error'
55
+ */
12
56
  level?: LoggerLevel;
57
+ /**
58
+ * Use JSON or text output (default: `true`)
59
+ * @default true
60
+ */
13
61
  json?: boolean;
62
+ /**
63
+ * Use color in text output (default: `false`)
64
+ * @default false
65
+ */
14
66
  color?: boolean;
67
+ /**
68
+ * Suppress log output, regardless of level (default: `false`)
69
+ * @default false
70
+ */
15
71
  silent?: boolean;
72
+ /**
73
+ * Include timestamps in text output (default: `true`)
74
+ * @default true
75
+ */
16
76
  timestamp?: boolean;
17
77
  }
78
+ /**
79
+ * Interface which represents a logger instance. Returned from call to `createLogger()`.
80
+ */
18
81
  export interface ILogger {
82
+ /**
83
+ * Return the name of the logger.
84
+ */
19
85
  getName(): string;
86
+ /**
87
+ * Return the logger type.
88
+ */
20
89
  getType(): LoggerType;
90
+ /**
91
+ * Update the logger configuration.
92
+ *
93
+ * @param props Adjustments to the logger configuration @see {@link LoggerSetLoggerProps}
94
+ */
21
95
  setLoggerProps(props: LoggerSetLoggerProps): void;
96
+ /**
97
+ * Create a log message with the specified log level.
98
+ *
99
+ * @param level Log level for this log message
100
+ * @param message text of the log message
101
+ * @param rest additional information to log (this will be appended as a JSON string to the message)
102
+ */
22
103
  log(level: LoggerLevel, message: string, ...rest: (string | number | boolean | object)[]): void;
104
+ /**
105
+ * Create a log message with log level **fatal**
106
+ *
107
+ * @param message text of the log message
108
+ * @param rest additional information to log (this will be appended as a JSON string to the message)
109
+ */
23
110
  fatal(message: string, ...rest: (string | number | boolean | object)[]): void;
111
+ /**
112
+ * Create a log message with log level **error**
113
+ *
114
+ * @param message text of the log message
115
+ * @param rest additional information to log (this will be appended as a JSON string to the message)
116
+ */
24
117
  error(message: string, ...rest: (string | number | boolean | object)[]): void;
118
+ /**
119
+ * Create a log message with log level **warn**
120
+ *
121
+ * @param message text of the log message
122
+ * @param rest additional information to log (this will be appended as a JSON string to the message)
123
+ */
25
124
  warn(message: string, ...rest: (string | number | boolean | object)[]): void;
125
+ /**
126
+ * Create a log message with log level **info**
127
+ *
128
+ * @param message text of the log message
129
+ * @param rest additional information to log (this will be appended as a JSON string to the message)
130
+ */
26
131
  info(message: string, ...rest: (string | number | boolean | object)[]): void;
132
+ /**
133
+ * Create a log message with log level **debug**
134
+ *
135
+ * @param message text of the log message
136
+ * @param rest additional information to log (this will be appended as a JSON string to the message)
137
+ */
27
138
  debug(message: string, ...rest: (string | number | boolean | object)[]): void;
139
+ /**
140
+ * Create a log message with log level **trace**
141
+ *
142
+ * @param message text of the log message
143
+ * @param rest additional information to log (this will be appended as a JSON string to the message)
144
+ */
28
145
  trace(message: string, ...rest: (string | number | boolean | object)[]): void;
29
146
  }
@@ -1,3 +1,3 @@
1
1
  // Copyright (C) 2025 Tim Hahn
2
2
  export {};
3
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2VyLXR5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2xvZ2dlci10eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSw4QkFBOEIiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBDb3B5cmlnaHQgKEMpIDIwMjUgVGltIEhhaG5cblxuZXhwb3J0IHR5cGUgTG9nZ2VyTGV2ZWwgPSAnZmF0YWwnIHwgJ2Vycm9yJyB8ICd3YXJuJyB8ICdpbmZvJyB8ICdkZWJ1ZycgfCAndHJhY2UnO1xuXG5leHBvcnQgdHlwZSBMb2dnZXJUeXBlID0gJ3NpbXBsZScgfCAnd2luc3Rvbic7XG5cbmV4cG9ydCBpbnRlcmZhY2UgTG9nZ2VyUHJvcHMge1xuICBuYW1lPzogc3RyaW5nO1xuICBsZXZlbD86IExvZ2dlckxldmVsO1xuICBqc29uPzogYm9vbGVhbjtcbiAgY29sb3I/OiBib29sZWFuO1xuICBzaWxlbnQ/OiBib29sZWFuO1xuICB0aW1lc3RhbXA/OiBib29sZWFuO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIExvZ2dlclNldExvZ2dlclByb3BzIHtcbiAgbGV2ZWw/OiBMb2dnZXJMZXZlbDtcbiAganNvbj86IGJvb2xlYW47XG4gIGNvbG9yPzogYm9vbGVhbjtcbiAgc2lsZW50PzogYm9vbGVhbjtcbiAgdGltZXN0YW1wPzogYm9vbGVhbjtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBJTG9nZ2VyIHtcbiAgZ2V0TmFtZSgpOiBzdHJpbmc7XG5cbiAgZ2V0VHlwZSgpOiBMb2dnZXJUeXBlO1xuXG4gIHNldExvZ2dlclByb3BzKHByb3BzOiBMb2dnZXJTZXRMb2dnZXJQcm9wcyk6IHZvaWQ7XG5cbiAgbG9nKGxldmVsOiBMb2dnZXJMZXZlbCwgbWVzc2FnZTogc3RyaW5nLCAuLi5yZXN0OiAoc3RyaW5nIHwgbnVtYmVyIHwgYm9vbGVhbiB8IG9iamVjdClbXSk6IHZvaWQ7XG5cbiAgZmF0YWwobWVzc2FnZTogc3RyaW5nLCAuLi5yZXN0OiAoc3RyaW5nIHwgbnVtYmVyIHwgYm9vbGVhbiB8IG9iamVjdClbXSk6IHZvaWQ7XG5cbiAgZXJyb3IobWVzc2FnZTogc3RyaW5nLCAuLi5yZXN0OiAoc3RyaW5nIHwgbnVtYmVyIHwgYm9vbGVhbiB8IG9iamVjdClbXSk6IHZvaWQ7XG5cbiAgd2FybihtZXNzYWdlOiBzdHJpbmcsIC4uLnJlc3Q6IChzdHJpbmcgfCBudW1iZXIgfCBib29sZWFuIHwgb2JqZWN0KVtdKTogdm9pZDtcblxuICBpbmZvKG1lc3NhZ2U6IHN0cmluZywgLi4ucmVzdDogKHN0cmluZyB8IG51bWJlciB8IGJvb2xlYW4gfCBvYmplY3QpW10pOiB2b2lkO1xuXG4gIGRlYnVnKG1lc3NhZ2U6IHN0cmluZywgLi4ucmVzdDogKHN0cmluZyB8IG51bWJlciB8IGJvb2xlYW4gfCBvYmplY3QpW10pOiB2b2lkO1xuXG4gIHRyYWNlKG1lc3NhZ2U6IHN0cmluZywgLi4ucmVzdDogKHN0cmluZyB8IG51bWJlciB8IGJvb2xlYW4gfCBvYmplY3QpW10pOiB2b2lkO1xufVxuIl19
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2VyLXR5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2xvZ2dlci10eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSw4QkFBOEIiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBDb3B5cmlnaHQgKEMpIDIwMjUgVGltIEhhaG5cblxuLyoqXG4gKiBMb2cgbGV2ZWwgc2V0dGluZ1xuICovXG5leHBvcnQgdHlwZSBMb2dnZXJMZXZlbCA9ICdmYXRhbCcgfCAnZXJyb3InIHwgJ3dhcm4nIHwgJ2luZm8nIHwgJ2RlYnVnJyB8ICd0cmFjZSc7XG5cbi8qKlxuICogTG9nZ2VyIHR5cGUgZm9yIHtAbGluayBjcmVhdGVMb2dnZXJ9IHRvIGNyZWF0ZVxuICovXG5leHBvcnQgdHlwZSBMb2dnZXJUeXBlID0gJ3NpbXBsZScgfCAnd2luc3Rvbic7XG5cbi8qKlxuICogT3B0aW9ucyBmb3IgY3JlYXRpbmcvZ2V0dGluZyBhIGxvZ2dlci4gIFVzZWQgd2hlbiBjYWxsaW5nIGBjcmVhdGVMb2dnZXIoKWAuXG4gKlxuICogQHNlZSB7QGxpbmsgY3JlYXRlTG9nZ2VyfVxuICpcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBMb2dnZXJQcm9wcyB7XG4gIC8qKlxuICAgKiBUaGUgbmFtZSBmb3IgdGhlIGxvZ2dlclxuICAgKiBAZGVmYXVsdCAnZGVmYXVsdCcgKHN1cHByZXNzZWQgZnJvbSBsb2cgcmVjb3JkcylcbiAgICovXG4gIG5hbWU/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFRoZSBsb2dnaW5nIGxldmVsIHRvIHVzZSwgKGRlZmF1bHQ6IGAnZXJyb3InYClcbiAgICogQGRlZmF1bHQgJ2Vycm9yJ1xuICAgKi9cbiAgbGV2ZWw/OiBMb2dnZXJMZXZlbDtcblxuICAvKipcbiAgICogVXNlIEpTT04gb3IgdGV4dCBvdXRwdXQgKGRlZmF1bHQ6IGB0cnVlYClcbiAgICogQGRlZmF1bHQgdHJ1ZVxuICAgKi9cbiAganNvbj86IGJvb2xlYW47XG5cbiAgLyoqXG4gICAqIFVzZSBjb2xvciBpbiB0ZXh0IG91dHB1dCAoZGVmYXVsdDogYGZhbHNlYClcbiAgICogQGRlZmF1bHQgZmFsc2VcbiAgICovXG4gIGNvbG9yPzogYm9vbGVhbjtcblxuICAvKipcbiAgICogU3VwcHJlc3MgbG9nIG91dHB1dCwgcmVnYXJkbGVzcyBvZiBsZXZlbCAoZGVmYXVsdDogYGZhbHNlYClcbiAgICogQGRlZmF1bHQgZmFsc2VcbiAgICovXG4gIHNpbGVudD86IGJvb2xlYW47XG5cbiAgLyoqXG4gICAqIEluY2x1ZGUgdGltZXN0YW1wcyBpbiB0ZXh0IG91dHB1dCAoZGVmYXVsdDogYHRydWVgKVxuICAgKiBAZGVmYXVsdCB0cnVlXG4gICAqL1xuICB0aW1lc3RhbXA/OiBib29sZWFuO1xufVxuXG4vKipcbiAqIE9wdGlvbnMgZm9yIHVwZGF0aW5nIGEgbG9nZ2VyIGNvbmZpZ3VyYXRpb24uICBVc2VkIHdoZW4gY2FsbGluZyBgSUxvZ2dlci5zZXRMb2dnZXJQcm9wcygpYC5cbiAqIEBzZWUge0BsaW5rIElMb2dnZXIuc2V0TG9nZ2VyUHJvcHN9XG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgTG9nZ2VyU2V0TG9nZ2VyUHJvcHMge1xuICAvKipcbiAgICogVGhlIGxvZ2dpbmcgbGV2ZWwgdG8gdXNlLCAoZGVmYXVsdDogYCdlcnJvcidgKVxuICAgKiBAZGVmYXVsdCAnZXJyb3InXG4gICAqL1xuICBsZXZlbD86IExvZ2dlckxldmVsO1xuXG4gIC8qKlxuICAgKiBVc2UgSlNPTiBvciB0ZXh0IG91dHB1dCAoZGVmYXVsdDogYHRydWVgKVxuICAgKiBAZGVmYXVsdCB0cnVlXG4gICAqL1xuICBqc29uPzogYm9vbGVhbjtcblxuICAvKipcbiAgICogVXNlIGNvbG9yIGluIHRleHQgb3V0cHV0IChkZWZhdWx0OiBgZmFsc2VgKVxuICAgKiBAZGVmYXVsdCBmYWxzZVxuICAgKi9cbiAgY29sb3I/OiBib29sZWFuO1xuXG4gIC8qKlxuICAgKiBTdXBwcmVzcyBsb2cgb3V0cHV0LCByZWdhcmRsZXNzIG9mIGxldmVsIChkZWZhdWx0OiBgZmFsc2VgKVxuICAgKiBAZGVmYXVsdCBmYWxzZVxuICAgKi9cbiAgc2lsZW50PzogYm9vbGVhbjtcblxuICAvKipcbiAgICogSW5jbHVkZSB0aW1lc3RhbXBzIGluIHRleHQgb3V0cHV0IChkZWZhdWx0OiBgdHJ1ZWApXG4gICAqIEBkZWZhdWx0IHRydWVcbiAgICovXG4gIHRpbWVzdGFtcD86IGJvb2xlYW47XG59XG5cbi8qKlxuICogSW50ZXJmYWNlIHdoaWNoIHJlcHJlc2VudHMgYSBsb2dnZXIgaW5zdGFuY2UuICBSZXR1cm5lZCBmcm9tIGNhbGwgdG8gYGNyZWF0ZUxvZ2dlcigpYC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBJTG9nZ2VyIHtcbiAgLyoqXG4gICAqIFJldHVybiB0aGUgbmFtZSBvZiB0aGUgbG9nZ2VyLlxuICAgKi9cbiAgZ2V0TmFtZSgpOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFJldHVybiB0aGUgbG9nZ2VyIHR5cGUuXG4gICAqL1xuICBnZXRUeXBlKCk6IExvZ2dlclR5cGU7XG5cbiAgLyoqXG4gICAqIFVwZGF0ZSB0aGUgbG9nZ2VyIGNvbmZpZ3VyYXRpb24uXG4gICAqXG4gICAqIEBwYXJhbSBwcm9wcyBBZGp1c3RtZW50cyB0byB0aGUgbG9nZ2VyIGNvbmZpZ3VyYXRpb24gQHNlZSB7QGxpbmsgTG9nZ2VyU2V0TG9nZ2VyUHJvcHN9XG4gICAqL1xuICBzZXRMb2dnZXJQcm9wcyhwcm9wczogTG9nZ2VyU2V0TG9nZ2VyUHJvcHMpOiB2b2lkO1xuXG4gIC8qKlxuICAgKiBDcmVhdGUgYSBsb2cgbWVzc2FnZSB3aXRoIHRoZSBzcGVjaWZpZWQgbG9nIGxldmVsLlxuICAgKlxuICAgKiBAcGFyYW0gbGV2ZWwgTG9nIGxldmVsIGZvciB0aGlzIGxvZyBtZXNzYWdlXG4gICAqIEBwYXJhbSBtZXNzYWdlIHRleHQgb2YgdGhlIGxvZyBtZXNzYWdlXG4gICAqIEBwYXJhbSByZXN0IGFkZGl0aW9uYWwgaW5mb3JtYXRpb24gdG8gbG9nICh0aGlzIHdpbGwgYmUgYXBwZW5kZWQgYXMgYSBKU09OIHN0cmluZyB0byB0aGUgbWVzc2FnZSlcbiAgICovXG4gIGxvZyhsZXZlbDogTG9nZ2VyTGV2ZWwsIG1lc3NhZ2U6IHN0cmluZywgLi4ucmVzdDogKHN0cmluZyB8IG51bWJlciB8IGJvb2xlYW4gfCBvYmplY3QpW10pOiB2b2lkO1xuXG4gIC8qKlxuICAgKiBDcmVhdGUgYSBsb2cgbWVzc2FnZSB3aXRoIGxvZyBsZXZlbCAqKmZhdGFsKipcbiAgICpcbiAgICogQHBhcmFtIG1lc3NhZ2UgdGV4dCBvZiB0aGUgbG9nIG1lc3NhZ2VcbiAgICogQHBhcmFtIHJlc3QgYWRkaXRpb25hbCBpbmZvcm1hdGlvbiB0byBsb2cgKHRoaXMgd2lsbCBiZSBhcHBlbmRlZCBhcyBhIEpTT04gc3RyaW5nIHRvIHRoZSBtZXNzYWdlKVxuICAgKi9cbiAgZmF0YWwobWVzc2FnZTogc3RyaW5nLCAuLi5yZXN0OiAoc3RyaW5nIHwgbnVtYmVyIHwgYm9vbGVhbiB8IG9iamVjdClbXSk6IHZvaWQ7XG5cbiAgLyoqXG4gICAqIENyZWF0ZSBhIGxvZyBtZXNzYWdlIHdpdGggbG9nIGxldmVsICoqZXJyb3IqKlxuICAgKlxuICAgKiBAcGFyYW0gbWVzc2FnZSB0ZXh0IG9mIHRoZSBsb2cgbWVzc2FnZVxuICAgKiBAcGFyYW0gcmVzdCBhZGRpdGlvbmFsIGluZm9ybWF0aW9uIHRvIGxvZyAodGhpcyB3aWxsIGJlIGFwcGVuZGVkIGFzIGEgSlNPTiBzdHJpbmcgdG8gdGhlIG1lc3NhZ2UpXG4gICAqL1xuICBlcnJvcihtZXNzYWdlOiBzdHJpbmcsIC4uLnJlc3Q6IChzdHJpbmcgfCBudW1iZXIgfCBib29sZWFuIHwgb2JqZWN0KVtdKTogdm9pZDtcblxuICAvKipcbiAgICogQ3JlYXRlIGEgbG9nIG1lc3NhZ2Ugd2l0aCBsb2cgbGV2ZWwgKip3YXJuKipcbiAgICpcbiAgICogQHBhcmFtIG1lc3NhZ2UgdGV4dCBvZiB0aGUgbG9nIG1lc3NhZ2VcbiAgICogQHBhcmFtIHJlc3QgYWRkaXRpb25hbCBpbmZvcm1hdGlvbiB0byBsb2cgKHRoaXMgd2lsbCBiZSBhcHBlbmRlZCBhcyBhIEpTT04gc3RyaW5nIHRvIHRoZSBtZXNzYWdlKVxuICAgKi9cbiAgd2FybihtZXNzYWdlOiBzdHJpbmcsIC4uLnJlc3Q6IChzdHJpbmcgfCBudW1iZXIgfCBib29sZWFuIHwgb2JqZWN0KVtdKTogdm9pZDtcblxuICAvKipcbiAgICogQ3JlYXRlIGEgbG9nIG1lc3NhZ2Ugd2l0aCBsb2cgbGV2ZWwgKippbmZvKipcbiAgICpcbiAgICogQHBhcmFtIG1lc3NhZ2UgdGV4dCBvZiB0aGUgbG9nIG1lc3NhZ2VcbiAgICogQHBhcmFtIHJlc3QgYWRkaXRpb25hbCBpbmZvcm1hdGlvbiB0byBsb2cgKHRoaXMgd2lsbCBiZSBhcHBlbmRlZCBhcyBhIEpTT04gc3RyaW5nIHRvIHRoZSBtZXNzYWdlKVxuICAgKi9cbiAgaW5mbyhtZXNzYWdlOiBzdHJpbmcsIC4uLnJlc3Q6IChzdHJpbmcgfCBudW1iZXIgfCBib29sZWFuIHwgb2JqZWN0KVtdKTogdm9pZDtcblxuICAvKipcbiAgICogQ3JlYXRlIGEgbG9nIG1lc3NhZ2Ugd2l0aCBsb2cgbGV2ZWwgKipkZWJ1ZyoqXG4gICAqXG4gICAqIEBwYXJhbSBtZXNzYWdlIHRleHQgb2YgdGhlIGxvZyBtZXNzYWdlXG4gICAqIEBwYXJhbSByZXN0IGFkZGl0aW9uYWwgaW5mb3JtYXRpb24gdG8gbG9nICh0aGlzIHdpbGwgYmUgYXBwZW5kZWQgYXMgYSBKU09OIHN0cmluZyB0byB0aGUgbWVzc2FnZSlcbiAgICovXG4gIGRlYnVnKG1lc3NhZ2U6IHN0cmluZywgLi4ucmVzdDogKHN0cmluZyB8IG51bWJlciB8IGJvb2xlYW4gfCBvYmplY3QpW10pOiB2b2lkO1xuXG4gIC8qKlxuICAgKiBDcmVhdGUgYSBsb2cgbWVzc2FnZSB3aXRoIGxvZyBsZXZlbCAqKnRyYWNlKipcbiAgICpcbiAgICogQHBhcmFtIG1lc3NhZ2UgdGV4dCBvZiB0aGUgbG9nIG1lc3NhZ2VcbiAgICogQHBhcmFtIHJlc3QgYWRkaXRpb25hbCBpbmZvcm1hdGlvbiB0byBsb2cgKHRoaXMgd2lsbCBiZSBhcHBlbmRlZCBhcyBhIEpTT04gc3RyaW5nIHRvIHRoZSBtZXNzYWdlKVxuICAgKi9cbiAgdHJhY2UobWVzc2FnZTogc3RyaW5nLCAuLi5yZXN0OiAoc3RyaW5nIHwgbnVtYmVyIHwgYm9vbGVhbiB8IG9iamVjdClbXSk6IHZvaWQ7XG59XG4iXX0=
package/lib/logger.d.ts CHANGED
@@ -1,3 +1,10 @@
1
1
  import { ILogger, LoggerType, LoggerLevel, LoggerProps, LoggerSetLoggerProps } from './logger-types.js';
2
- export { ILogger, LoggerLevel, LoggerProps, LoggerSetLoggerProps };
2
+ export { ILogger, LoggerType, LoggerLevel, LoggerProps, LoggerSetLoggerProps };
3
+ /**
4
+ * Create (or get an existing) logger to use.
5
+ *
6
+ * @param type The type of logger to create
7
+ * @param props Initialization properties for the logger
8
+ * @returns an object that implements the {@link ILogger} interface
9
+ */
3
10
  export declare function createLogger(type: LoggerType, props?: LoggerProps): ILogger;
package/lib/logger.js CHANGED
@@ -19,6 +19,13 @@ async function initializeLoggerClasses() {
19
19
  };
20
20
  }
21
21
  }
22
+ /**
23
+ * Create (or get an existing) logger to use.
24
+ *
25
+ * @param type The type of logger to create
26
+ * @param props Initialization properties for the logger
27
+ * @returns an object that implements the {@link ILogger} interface
28
+ */
22
29
  export function createLogger(type, props) {
23
30
  const loggerName = props?.name ?? 'default'; // covers case where props.name === ''
24
31
  const existingLogger = loggers.find((logger) => logger.getName() === loggerName);
@@ -46,4 +53,4 @@ export function createLogger(type, props) {
46
53
  return newLogger;
47
54
  }
48
55
  await initializeLoggerClasses();
49
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2xvZ2dlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSw4QkFBOEI7QUFjOUIsNEVBQTRFO0FBQzVFLE1BQU0sTUFBTSxHQUFHLE9BQU8sT0FBTyxLQUFLLFdBQVcsSUFBSSxVQUFVLENBQUMsT0FBTyxLQUFLLE9BQU8sQ0FBQztBQUVoRixNQUFNLGFBQWEsR0FBa0IsRUFBRSxDQUFDO0FBRXhDLE1BQU0sT0FBTyxHQUFjLEVBQUUsQ0FBQztBQUU5QixLQUFLLFVBQVUsdUJBQXVCO0lBQ3BDLElBQUksbUJBQW1CLENBQUM7SUFDeEIsSUFBSSxrQkFBa0IsQ0FBQztJQUV2QixDQUFDLEVBQUUsa0JBQWtCLEVBQUUsR0FBRyxNQUFNLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDLENBQUM7SUFFOUQsYUFBYSxDQUFDLENBQUMsQ0FBQyxHQUFHO1FBQ2pCLElBQUksRUFBRSxRQUFRO1FBQ2QsYUFBYSxFQUFFLGtCQUFrQjtLQUNsQyxDQUFDO0lBRUYsSUFBSSxNQUFNLEVBQUUsQ0FBQztRQUNYLENBQUMsRUFBRSxtQkFBbUIsRUFBRSxHQUFHLE1BQU0sTUFBTSxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQztRQUVoRSxhQUFhLENBQUMsQ0FBQyxDQUFDLEdBQUc7WUFDakIsSUFBSSxFQUFFLFNBQVM7WUFDZixhQUFhLEVBQUUsbUJBQW1CO1NBQ25DLENBQUM7SUFDSixDQUFDO0FBQ0gsQ0FBQztBQUVELE1BQU0sVUFBVSxZQUFZLENBQUMsSUFBZ0IsRUFBRSxLQUFtQjtJQUNoRSxNQUFNLFVBQVUsR0FBRyxLQUFLLEVBQUUsSUFBSSxJQUFJLFNBQVMsQ0FBQyxDQUFDLHNDQUFzQztJQUVuRixNQUFNLGNBQWMsR0FBd0IsT0FBTyxDQUFDLElBQUksQ0FDdEQsQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxPQUFPLEVBQUUsS0FBSyxVQUFVLENBQzVDLENBQUM7SUFFRixJQUFJLGNBQWMsRUFBRSxDQUFDO1FBQ25CLElBQUksY0FBYyxDQUFDLE9BQU8sRUFBRSxLQUFLLElBQUksRUFBRSxDQUFDO1lBQ3RDLGNBQWMsQ0FBQyxJQUFJLENBQ2pCLHNFQUFzRSxJQUFJLEVBQUUsQ0FDN0UsQ0FBQztRQUNKLENBQUM7UUFDRCxJQUFJLEtBQUssRUFBRSxDQUFDO1lBQ1YsY0FBYyxDQUFDLElBQUksQ0FDakIsbUZBQW1GLENBQ3BGLENBQUM7UUFDSixDQUFDO1FBQ0QsT0FBTyxjQUFjLENBQUM7SUFDeEIsQ0FBQztJQUVELE1BQU0sY0FBYyxHQUFnQixFQUFFLEdBQUcsS0FBSyxFQUFFLENBQUM7SUFDakQsY0FBYyxDQUFDLElBQUksR0FBRyxVQUFVLENBQUM7SUFFakMsSUFBSSxXQUFXLEdBQTRCLGFBQWEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLEtBQUssSUFBSSxDQUFDLENBQUM7SUFDNUYsSUFBSSxTQUFTLEdBQXdCLFNBQVMsQ0FBQztJQUMvQyxJQUFJLFdBQVcsRUFBRSxDQUFDO1FBQ2hCLFNBQVMsR0FBRyxXQUFXLENBQUMsYUFBYSxDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQ3hELENBQUM7U0FBTSxDQUFDO1FBQ04sU0FBUyxHQUFHLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUMsY0FBYyxDQUFDLENBQUM7UUFDM0QsU0FBUyxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsZUFBZSxJQUFJLDBDQUEwQyxDQUFDLENBQUM7SUFDdkYsQ0FBQztJQUVELE9BQU8sQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUM7SUFFeEIsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVELE1BQU0sdUJBQXVCLEVBQUUsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIENvcHlyaWdodCAoQykgMjAyNSBUaW0gSGFoblxuXG5pbXBvcnQge1xuICBJTG9nZ2VyLFxuICBMb2dnZXJUeXBlLFxuICBMb2dnZXJMZXZlbCxcbiAgTG9nZ2VyUHJvcHMsXG4gIExvZ2dlclNldExvZ2dlclByb3BzLFxufSBmcm9tICcuL2xvZ2dlci10eXBlcy5qcyc7XG5cbmV4cG9ydCB7IElMb2dnZXIsIExvZ2dlckxldmVsLCBMb2dnZXJQcm9wcywgTG9nZ2VyU2V0TG9nZ2VyUHJvcHMgfTtcblxudHlwZSBMb2dnZXJDbGFzcyA9IHsgdHlwZTogTG9nZ2VyVHlwZTsgbG9nZ2VyQ3JlYXRvcjogKHByb3BzPzogTG9nZ2VyUHJvcHMpID0+IElMb2dnZXIgfTtcblxuLy8gY29uc3QgaXNCcm93c2VyID0gdHlwZW9mIHdpbmRvdyAhPT0gJ3VuZGVmaW5lZCcgJiYgZ2xvYmFsVGhpcyA9PT0gd2luZG93O1xuY29uc3QgaXNOb2RlID0gdHlwZW9mIHByb2Nlc3MgIT09ICd1bmRlZmluZWQnICYmIGdsb2JhbFRoaXMucHJvY2VzcyA9PT0gcHJvY2VzcztcblxuY29uc3QgbG9nZ2VyQ2xhc3NlczogTG9nZ2VyQ2xhc3NbXSA9IFtdO1xuXG5jb25zdCBsb2dnZXJzOiBJTG9nZ2VyW10gPSBbXTtcblxuYXN5bmMgZnVuY3Rpb24gaW5pdGlhbGl6ZUxvZ2dlckNsYXNzZXMoKSB7XG4gIGxldCBjcmVhdGVXaW5zdG9uTG9nZ2VyO1xuICBsZXQgY3JlYXRlU2ltcGxlTG9nZ2VyO1xuXG4gICh7IGNyZWF0ZVNpbXBsZUxvZ2dlciB9ID0gYXdhaXQgaW1wb3J0KCcuL3NpbXBsZS1sb2dnZXIuanMnKSk7XG5cbiAgbG9nZ2VyQ2xhc3Nlc1swXSA9IHtcbiAgICB0eXBlOiAnc2ltcGxlJyxcbiAgICBsb2dnZXJDcmVhdG9yOiBjcmVhdGVTaW1wbGVMb2dnZXIsXG4gIH07XG5cbiAgaWYgKGlzTm9kZSkge1xuICAgICh7IGNyZWF0ZVdpbnN0b25Mb2dnZXIgfSA9IGF3YWl0IGltcG9ydCgnLi93aW5zdG9uLWxvZ2dlci5qcycpKTtcblxuICAgIGxvZ2dlckNsYXNzZXNbMV0gPSB7XG4gICAgICB0eXBlOiAnd2luc3RvbicsXG4gICAgICBsb2dnZXJDcmVhdG9yOiBjcmVhdGVXaW5zdG9uTG9nZ2VyLFxuICAgIH07XG4gIH1cbn1cblxuZXhwb3J0IGZ1bmN0aW9uIGNyZWF0ZUxvZ2dlcih0eXBlOiBMb2dnZXJUeXBlLCBwcm9wcz86IExvZ2dlclByb3BzKTogSUxvZ2dlciB7XG4gIGNvbnN0IGxvZ2dlck5hbWUgPSBwcm9wcz8ubmFtZSA/PyAnZGVmYXVsdCc7IC8vIGNvdmVycyBjYXNlIHdoZXJlIHByb3BzLm5hbWUgPT09ICcnXG5cbiAgY29uc3QgZXhpc3RpbmdMb2dnZXI6IElMb2dnZXIgfCB1bmRlZmluZWQgPSBsb2dnZXJzLmZpbmQoXG4gICAgKGxvZ2dlcikgPT4gbG9nZ2VyLmdldE5hbWUoKSA9PT0gbG9nZ2VyTmFtZSxcbiAgKTtcblxuICBpZiAoZXhpc3RpbmdMb2dnZXIpIHtcbiAgICBpZiAoZXhpc3RpbmdMb2dnZXIuZ2V0VHlwZSgpICE9PSB0eXBlKSB7XG4gICAgICBleGlzdGluZ0xvZ2dlci53YXJuKFxuICAgICAgICBgY3JlYXRlTG9nZ2VyOiBleGlzdGluZyBMb2dnZXIgZm91bmQgZG9lcyBub3QgbWF0Y2ggdHlwZSByZXF1ZXN0ZWQ6ICR7dHlwZX1gLFxuICAgICAgKTtcbiAgICB9XG4gICAgaWYgKHByb3BzKSB7XG4gICAgICBleGlzdGluZ0xvZ2dlci53YXJuKFxuICAgICAgICAnY3JlYXRlTG9nZ2VyOiBleGlzdGluZyBMb2dnZXIgZm91bmQsIHN1cHBsaWVkIHByb3BzIGlnbm9yZWQsIHVzZSBzZXRMb2dnZXJQcm9wcygpJyxcbiAgICAgICk7XG4gICAgfVxuICAgIHJldHVybiBleGlzdGluZ0xvZ2dlcjtcbiAgfVxuXG4gIGNvbnN0IG5ld0xvZ2dlclByb3BzOiBMb2dnZXJQcm9wcyA9IHsgLi4ucHJvcHMgfTtcbiAgbmV3TG9nZ2VyUHJvcHMubmFtZSA9IGxvZ2dlck5hbWU7XG5cbiAgbGV0IGxvZ2dlckNsYXNzOiBMb2dnZXJDbGFzcyB8IHVuZGVmaW5lZCA9IGxvZ2dlckNsYXNzZXMuZmluZCgoaXRlbSkgPT4gaXRlbS50eXBlID09PSB0eXBlKTtcbiAgbGV0IG5ld0xvZ2dlcjogSUxvZ2dlciB8IHVuZGVmaW5lZCA9IHVuZGVmaW5lZDtcbiAgaWYgKGxvZ2dlckNsYXNzKSB7XG4gICAgbmV3TG9nZ2VyID0gbG9nZ2VyQ2xhc3MubG9nZ2VyQ3JlYXRvcihuZXdMb2dnZXJQcm9wcyk7XG4gIH0gZWxzZSB7XG4gICAgbmV3TG9nZ2VyID0gbG9nZ2VyQ2xhc3Nlc1swXS5sb2dnZXJDcmVhdG9yKG5ld0xvZ2dlclByb3BzKTtcbiAgICBuZXdMb2dnZXIubG9nKCd3YXJuJywgYGxvZ2dlclR5cGU6ICR7dHlwZX0gbm90IGZvdW5kLCBmYWxsaW5nIGJhY2sgdG8gU2ltcGxlTG9nZ2VyYCk7XG4gIH1cblxuICBsb2dnZXJzLnB1c2gobmV3TG9nZ2VyKTtcblxuICByZXR1cm4gbmV3TG9nZ2VyO1xufVxuXG5hd2FpdCBpbml0aWFsaXplTG9nZ2VyQ2xhc3NlcygpO1xuIl19
56
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2xvZ2dlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSw4QkFBOEI7QUFjOUIsNEVBQTRFO0FBQzVFLE1BQU0sTUFBTSxHQUFHLE9BQU8sT0FBTyxLQUFLLFdBQVcsSUFBSSxVQUFVLENBQUMsT0FBTyxLQUFLLE9BQU8sQ0FBQztBQUVoRixNQUFNLGFBQWEsR0FBa0IsRUFBRSxDQUFDO0FBRXhDLE1BQU0sT0FBTyxHQUFjLEVBQUUsQ0FBQztBQUU5QixLQUFLLFVBQVUsdUJBQXVCO0lBQ3BDLElBQUksbUJBQW1CLENBQUM7SUFDeEIsSUFBSSxrQkFBa0IsQ0FBQztJQUV2QixDQUFDLEVBQUUsa0JBQWtCLEVBQUUsR0FBRyxNQUFNLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDLENBQUM7SUFFOUQsYUFBYSxDQUFDLENBQUMsQ0FBQyxHQUFHO1FBQ2pCLElBQUksRUFBRSxRQUFRO1FBQ2QsYUFBYSxFQUFFLGtCQUFrQjtLQUNsQyxDQUFDO0lBRUYsSUFBSSxNQUFNLEVBQUUsQ0FBQztRQUNYLENBQUMsRUFBRSxtQkFBbUIsRUFBRSxHQUFHLE1BQU0sTUFBTSxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQztRQUVoRSxhQUFhLENBQUMsQ0FBQyxDQUFDLEdBQUc7WUFDakIsSUFBSSxFQUFFLFNBQVM7WUFDZixhQUFhLEVBQUUsbUJBQW1CO1NBQ25DLENBQUM7SUFDSixDQUFDO0FBQ0gsQ0FBQztBQUVEOzs7Ozs7R0FNRztBQUNILE1BQU0sVUFBVSxZQUFZLENBQUMsSUFBZ0IsRUFBRSxLQUFtQjtJQUNoRSxNQUFNLFVBQVUsR0FBRyxLQUFLLEVBQUUsSUFBSSxJQUFJLFNBQVMsQ0FBQyxDQUFDLHNDQUFzQztJQUVuRixNQUFNLGNBQWMsR0FBd0IsT0FBTyxDQUFDLElBQUksQ0FDdEQsQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxPQUFPLEVBQUUsS0FBSyxVQUFVLENBQzVDLENBQUM7SUFFRixJQUFJLGNBQWMsRUFBRSxDQUFDO1FBQ25CLElBQUksY0FBYyxDQUFDLE9BQU8sRUFBRSxLQUFLLElBQUksRUFBRSxDQUFDO1lBQ3RDLGNBQWMsQ0FBQyxJQUFJLENBQ2pCLHNFQUFzRSxJQUFJLEVBQUUsQ0FDN0UsQ0FBQztRQUNKLENBQUM7UUFDRCxJQUFJLEtBQUssRUFBRSxDQUFDO1lBQ1YsY0FBYyxDQUFDLElBQUksQ0FDakIsbUZBQW1GLENBQ3BGLENBQUM7UUFDSixDQUFDO1FBQ0QsT0FBTyxjQUFjLENBQUM7SUFDeEIsQ0FBQztJQUVELE1BQU0sY0FBYyxHQUFnQixFQUFFLEdBQUcsS0FBSyxFQUFFLENBQUM7SUFDakQsY0FBYyxDQUFDLElBQUksR0FBRyxVQUFVLENBQUM7SUFFakMsSUFBSSxXQUFXLEdBQTRCLGFBQWEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLEtBQUssSUFBSSxDQUFDLENBQUM7SUFDNUYsSUFBSSxTQUFTLEdBQXdCLFNBQVMsQ0FBQztJQUMvQyxJQUFJLFdBQVcsRUFBRSxDQUFDO1FBQ2hCLFNBQVMsR0FBRyxXQUFXLENBQUMsYUFBYSxDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQ3hELENBQUM7U0FBTSxDQUFDO1FBQ04sU0FBUyxHQUFHLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUMsY0FBYyxDQUFDLENBQUM7UUFDM0QsU0FBUyxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsZUFBZSxJQUFJLDBDQUEwQyxDQUFDLENBQUM7SUFDdkYsQ0FBQztJQUVELE9BQU8sQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUM7SUFFeEIsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVELE1BQU0sdUJBQXVCLEVBQUUsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIENvcHlyaWdodCAoQykgMjAyNSBUaW0gSGFoblxuXG5pbXBvcnQge1xuICBJTG9nZ2VyLFxuICBMb2dnZXJUeXBlLFxuICBMb2dnZXJMZXZlbCxcbiAgTG9nZ2VyUHJvcHMsXG4gIExvZ2dlclNldExvZ2dlclByb3BzLFxufSBmcm9tICcuL2xvZ2dlci10eXBlcy5qcyc7XG5cbmV4cG9ydCB7IElMb2dnZXIsIExvZ2dlclR5cGUsIExvZ2dlckxldmVsLCBMb2dnZXJQcm9wcywgTG9nZ2VyU2V0TG9nZ2VyUHJvcHMgfTtcblxudHlwZSBMb2dnZXJDbGFzcyA9IHsgdHlwZTogTG9nZ2VyVHlwZTsgbG9nZ2VyQ3JlYXRvcjogKHByb3BzPzogTG9nZ2VyUHJvcHMpID0+IElMb2dnZXIgfTtcblxuLy8gY29uc3QgaXNCcm93c2VyID0gdHlwZW9mIHdpbmRvdyAhPT0gJ3VuZGVmaW5lZCcgJiYgZ2xvYmFsVGhpcyA9PT0gd2luZG93O1xuY29uc3QgaXNOb2RlID0gdHlwZW9mIHByb2Nlc3MgIT09ICd1bmRlZmluZWQnICYmIGdsb2JhbFRoaXMucHJvY2VzcyA9PT0gcHJvY2VzcztcblxuY29uc3QgbG9nZ2VyQ2xhc3NlczogTG9nZ2VyQ2xhc3NbXSA9IFtdO1xuXG5jb25zdCBsb2dnZXJzOiBJTG9nZ2VyW10gPSBbXTtcblxuYXN5bmMgZnVuY3Rpb24gaW5pdGlhbGl6ZUxvZ2dlckNsYXNzZXMoKSB7XG4gIGxldCBjcmVhdGVXaW5zdG9uTG9nZ2VyO1xuICBsZXQgY3JlYXRlU2ltcGxlTG9nZ2VyO1xuXG4gICh7IGNyZWF0ZVNpbXBsZUxvZ2dlciB9ID0gYXdhaXQgaW1wb3J0KCcuL3NpbXBsZS1sb2dnZXIuanMnKSk7XG5cbiAgbG9nZ2VyQ2xhc3Nlc1swXSA9IHtcbiAgICB0eXBlOiAnc2ltcGxlJyxcbiAgICBsb2dnZXJDcmVhdG9yOiBjcmVhdGVTaW1wbGVMb2dnZXIsXG4gIH07XG5cbiAgaWYgKGlzTm9kZSkge1xuICAgICh7IGNyZWF0ZVdpbnN0b25Mb2dnZXIgfSA9IGF3YWl0IGltcG9ydCgnLi93aW5zdG9uLWxvZ2dlci5qcycpKTtcblxuICAgIGxvZ2dlckNsYXNzZXNbMV0gPSB7XG4gICAgICB0eXBlOiAnd2luc3RvbicsXG4gICAgICBsb2dnZXJDcmVhdG9yOiBjcmVhdGVXaW5zdG9uTG9nZ2VyLFxuICAgIH07XG4gIH1cbn1cblxuLyoqXG4gKiBDcmVhdGUgKG9yIGdldCBhbiBleGlzdGluZykgbG9nZ2VyIHRvIHVzZS5cbiAqXG4gKiBAcGFyYW0gdHlwZSBUaGUgdHlwZSBvZiBsb2dnZXIgdG8gY3JlYXRlXG4gKiBAcGFyYW0gcHJvcHMgSW5pdGlhbGl6YXRpb24gcHJvcGVydGllcyBmb3IgdGhlIGxvZ2dlclxuICogQHJldHVybnMgYW4gb2JqZWN0IHRoYXQgaW1wbGVtZW50cyB0aGUge0BsaW5rIElMb2dnZXJ9IGludGVyZmFjZVxuICovXG5leHBvcnQgZnVuY3Rpb24gY3JlYXRlTG9nZ2VyKHR5cGU6IExvZ2dlclR5cGUsIHByb3BzPzogTG9nZ2VyUHJvcHMpOiBJTG9nZ2VyIHtcbiAgY29uc3QgbG9nZ2VyTmFtZSA9IHByb3BzPy5uYW1lID8/ICdkZWZhdWx0JzsgLy8gY292ZXJzIGNhc2Ugd2hlcmUgcHJvcHMubmFtZSA9PT0gJydcblxuICBjb25zdCBleGlzdGluZ0xvZ2dlcjogSUxvZ2dlciB8IHVuZGVmaW5lZCA9IGxvZ2dlcnMuZmluZChcbiAgICAobG9nZ2VyKSA9PiBsb2dnZXIuZ2V0TmFtZSgpID09PSBsb2dnZXJOYW1lLFxuICApO1xuXG4gIGlmIChleGlzdGluZ0xvZ2dlcikge1xuICAgIGlmIChleGlzdGluZ0xvZ2dlci5nZXRUeXBlKCkgIT09IHR5cGUpIHtcbiAgICAgIGV4aXN0aW5nTG9nZ2VyLndhcm4oXG4gICAgICAgIGBjcmVhdGVMb2dnZXI6IGV4aXN0aW5nIExvZ2dlciBmb3VuZCBkb2VzIG5vdCBtYXRjaCB0eXBlIHJlcXVlc3RlZDogJHt0eXBlfWAsXG4gICAgICApO1xuICAgIH1cbiAgICBpZiAocHJvcHMpIHtcbiAgICAgIGV4aXN0aW5nTG9nZ2VyLndhcm4oXG4gICAgICAgICdjcmVhdGVMb2dnZXI6IGV4aXN0aW5nIExvZ2dlciBmb3VuZCwgc3VwcGxpZWQgcHJvcHMgaWdub3JlZCwgdXNlIHNldExvZ2dlclByb3BzKCknLFxuICAgICAgKTtcbiAgICB9XG4gICAgcmV0dXJuIGV4aXN0aW5nTG9nZ2VyO1xuICB9XG5cbiAgY29uc3QgbmV3TG9nZ2VyUHJvcHM6IExvZ2dlclByb3BzID0geyAuLi5wcm9wcyB9O1xuICBuZXdMb2dnZXJQcm9wcy5uYW1lID0gbG9nZ2VyTmFtZTtcblxuICBsZXQgbG9nZ2VyQ2xhc3M6IExvZ2dlckNsYXNzIHwgdW5kZWZpbmVkID0gbG9nZ2VyQ2xhc3Nlcy5maW5kKChpdGVtKSA9PiBpdGVtLnR5cGUgPT09IHR5cGUpO1xuICBsZXQgbmV3TG9nZ2VyOiBJTG9nZ2VyIHwgdW5kZWZpbmVkID0gdW5kZWZpbmVkO1xuICBpZiAobG9nZ2VyQ2xhc3MpIHtcbiAgICBuZXdMb2dnZXIgPSBsb2dnZXJDbGFzcy5sb2dnZXJDcmVhdG9yKG5ld0xvZ2dlclByb3BzKTtcbiAgfSBlbHNlIHtcbiAgICBuZXdMb2dnZXIgPSBsb2dnZXJDbGFzc2VzWzBdLmxvZ2dlckNyZWF0b3IobmV3TG9nZ2VyUHJvcHMpO1xuICAgIG5ld0xvZ2dlci5sb2coJ3dhcm4nLCBgbG9nZ2VyVHlwZTogJHt0eXBlfSBub3QgZm91bmQsIGZhbGxpbmcgYmFjayB0byBTaW1wbGVMb2dnZXJgKTtcbiAgfVxuXG4gIGxvZ2dlcnMucHVzaChuZXdMb2dnZXIpO1xuXG4gIHJldHVybiBuZXdMb2dnZXI7XG59XG5cbmF3YWl0IGluaXRpYWxpemVMb2dnZXJDbGFzc2VzKCk7XG4iXX0=
package/package.json CHANGED
@@ -34,6 +34,8 @@
34
34
  "ts-jest": "^29.4.11",
35
35
  "ts-node": "^10.9.2",
36
36
  "tsx": "^4.22.3",
37
+ "typedoc": "^0.28.19",
38
+ "typedoc-plugin-markdown": "^4.12.0",
37
39
  "typescript": "^5.9.3"
38
40
  },
39
41
  "dependencies": {
@@ -58,7 +60,7 @@
58
60
  },
59
61
  "main": "lib/index.js",
60
62
  "license": "MIT",
61
- "version": "0.0.24",
63
+ "version": "0.0.26",
62
64
  "jest": {
63
65
  "coverageProvider": "v8",
64
66
  "extensionsToTreatAsEsm": [
@@ -139,6 +141,7 @@
139
141
  "unbump": "projen unbump",
140
142
  "upgrade": "projen upgrade",
141
143
  "watch": "projen watch",
142
- "projen": "projen"
144
+ "projen": "projen",
145
+ "build:docs": "pnpm typedoc"
143
146
  }
144
147
  }
package/typedoc.json ADDED
@@ -0,0 +1,16 @@
1
+ {
2
+ "$schema": "https://typedoc.org/schema.json",
3
+ "plugin": [
4
+ "typedoc-plugin-markdown"
5
+ ],
6
+ "entryPoints": [
7
+ "./src/logger.ts"
8
+ ],
9
+ "out": "docs/api",
10
+ "cleanOutputDir": true,
11
+ "readme": "none",
12
+ "disableSources": true,
13
+ "entryFileName": "index",
14
+ "mergeReadme": false,
15
+ "hidePageHeader": true
16
+ }