@genesislcap/foundation-logger 14.302.0 → 14.302.1-alpha-945e484.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.
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.34.9"
8
+ "packageVersion": "7.52.10"
9
9
  }
10
10
  ]
11
11
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.34.9",
4
+ "toolVersion": "7.52.10",
5
5
  "schemaVersion": 1011,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
@@ -14,10 +14,55 @@ export declare function createLogger(name: string, options?: LoggerOptions): Log
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | name | string | The name to give the logger. |
20
- | options | [LoggerOptions](./foundation-logger.loggeroptions.md) | _(Optional)_ The options to use when creating the logger. |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ name
36
+
37
+
38
+ </td><td>
39
+
40
+ string
41
+
42
+
43
+ </td><td>
44
+
45
+ The name to give the logger.
46
+
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ options
52
+
53
+
54
+ </td><td>
55
+
56
+ [LoggerOptions](./foundation-logger.loggeroptions.md)
57
+
58
+
59
+ </td><td>
60
+
61
+ _(Optional)_ The options to use when creating the logger.
62
+
63
+
64
+ </td></tr>
65
+ </tbody></table>
21
66
 
22
67
  **Returns:**
23
68
 
@@ -14,11 +14,71 @@ deprecated(symbol: string, instruction?: string, removalVersionTarget?: string):
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | symbol | string | The deprecated symbol. |
20
- | instruction | string | _(Optional)_ An optional alternative instruction. Defaults to <code>Consult docs for better alternative.</code> |
21
- | removalVersionTarget | string | _(Optional)_ An optional target removal version number. |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ symbol
36
+
37
+
38
+ </td><td>
39
+
40
+ string
41
+
42
+
43
+ </td><td>
44
+
45
+ The deprecated symbol.
46
+
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ instruction
52
+
53
+
54
+ </td><td>
55
+
56
+ string
57
+
58
+
59
+ </td><td>
60
+
61
+ _(Optional)_ An optional alternative instruction. Defaults to `Consult docs for better alternative.`
62
+
63
+
64
+ </td></tr>
65
+ <tr><td>
66
+
67
+ removalVersionTarget
68
+
69
+
70
+ </td><td>
71
+
72
+ string
73
+
74
+
75
+ </td><td>
76
+
77
+ _(Optional)_ An optional target removal version number.
78
+
79
+
80
+ </td></tr>
81
+ </tbody></table>
22
82
 
23
83
  **Returns:**
24
84
 
@@ -19,7 +19,27 @@ This logger is part of the package's API but may still be subject to changes and
19
19
 
20
20
  ## Methods
21
21
 
22
- | Method | Description |
23
- | --- | --- |
24
- | [deprecated(symbol, instruction, removalVersionTarget)](./foundation-logger.logger.deprecated.md) | A logger method for deprecated symbols. |
22
+ <table><thead><tr><th>
23
+
24
+ Method
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ [deprecated(symbol, instruction, removalVersionTarget)](./foundation-logger.logger.deprecated.md)
36
+
37
+
38
+ </td><td>
39
+
40
+ A logger method for deprecated symbols.
41
+
42
+
43
+ </td></tr>
44
+ </tbody></table>
25
45
 
@@ -6,20 +6,90 @@
6
6
 
7
7
  ## Functions
8
8
 
9
- | Function | Description |
10
- | --- | --- |
11
- | [createLogger(name, options)](./foundation-logger.createlogger.md) | Creates a logger with the given name and options. |
9
+ <table><thead><tr><th>
10
+
11
+ Function
12
+
13
+
14
+ </th><th>
15
+
16
+ Description
17
+
18
+
19
+ </th></tr></thead>
20
+ <tbody><tr><td>
21
+
22
+ [createLogger(name, options)](./foundation-logger.createlogger.md)
23
+
24
+
25
+ </td><td>
26
+
27
+ Creates a logger with the given name and options.
28
+
29
+
30
+ </td></tr>
31
+ </tbody></table>
12
32
 
13
33
  ## Interfaces
14
34
 
15
- | Interface | Description |
16
- | --- | --- |
17
- | [Logger](./foundation-logger.logger.md) | A logger that extends the <code>Consola</code> logger. |
18
- | [LoggerOptions](./foundation-logger.loggeroptions.md) | Options for creating a logger. |
35
+ <table><thead><tr><th>
36
+
37
+ Interface
38
+
39
+
40
+ </th><th>
41
+
42
+ Description
43
+
44
+
45
+ </th></tr></thead>
46
+ <tbody><tr><td>
47
+
48
+ [Logger](./foundation-logger.logger.md)
49
+
50
+
51
+ </td><td>
52
+
53
+ A logger that extends the `Consola` logger.
54
+
55
+
56
+ </td></tr>
57
+ <tr><td>
58
+
59
+ [LoggerOptions](./foundation-logger.loggeroptions.md)
60
+
61
+
62
+ </td><td>
63
+
64
+ Options for creating a logger.
65
+
66
+
67
+ </td></tr>
68
+ </tbody></table>
19
69
 
20
70
  ## Variables
21
71
 
22
- | Variable | Description |
23
- | --- | --- |
24
- | [defaultLoggerOptions](./foundation-logger.defaultloggeroptions.md) | The default logger options. |
72
+ <table><thead><tr><th>
73
+
74
+ Variable
75
+
76
+
77
+ </th><th>
78
+
79
+ Description
80
+
81
+
82
+ </th></tr></thead>
83
+ <tbody><tr><td>
84
+
85
+ [defaultLoggerOptions](./foundation-logger.defaultloggeroptions.md)
86
+
87
+
88
+ </td><td>
89
+
90
+ The default logger options.
91
+
92
+
93
+ </td></tr>
94
+ </tbody></table>
25
95
 
package/docs/api/index.md CHANGED
@@ -6,7 +6,25 @@
6
6
 
7
7
  ## Packages
8
8
 
9
- | Package | Description |
10
- | --- | --- |
11
- | [@genesislcap/foundation-logger](./foundation-logger.md) | |
9
+ <table><thead><tr><th>
10
+
11
+ Package
12
+
13
+
14
+ </th><th>
15
+
16
+ Description
17
+
18
+
19
+ </th></tr></thead>
20
+ <tbody><tr><td>
21
+
22
+ [@genesislcap/foundation-logger](./foundation-logger.md)
23
+
24
+
25
+ </td><td>
26
+
27
+
28
+ </td></tr>
29
+ </tbody></table>
12
30
 
@@ -0,0 +1,37 @@
1
+ ## API Report File for "@genesislcap/foundation-logger"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { Consola } from 'consola';
8
+ import { ConsolaOptions } from 'consola';
9
+ import { LogLevel } from 'consola';
10
+ import { logType } from 'consola';
11
+
12
+ // @public
13
+ export function createLogger(name: string, options?: LoggerOptions): Logger;
14
+
15
+ // @public
16
+ export const defaultLoggerOptions: LoggerOptions;
17
+
18
+ // @public
19
+ export interface Logger extends Consola {
20
+ deprecated(symbol: string, instruction?: string, removalVersionTarget?: string): void;
21
+ }
22
+
23
+ // @public
24
+ export interface Logger extends Consola {
25
+ }
26
+
27
+ // @public
28
+ export interface LoggerOptions extends ConsolaOptions {
29
+ }
30
+
31
+ export { LogLevel }
32
+
33
+ export { logType }
34
+
35
+ // (No @packageDocumentation comment for this package)
36
+
37
+ ```
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-logger",
3
3
  "description": "Genesis Foundation Logger",
4
- "version": "14.302.0",
4
+ "version": "14.302.1-alpha-945e484.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -23,13 +23,13 @@
23
23
  },
24
24
  "devDependencies": {
25
25
  "@microsoft/api-documenter": "^7.19.13",
26
- "@microsoft/api-extractor": "7.34.9",
26
+ "@microsoft/api-extractor": "7.52.10",
27
27
  "rimraf": "^5.0.0",
28
- "typescript": "^4.9.5"
28
+ "typescript": "^5.9.2"
29
29
  },
30
30
  "dependencies": {
31
31
  "consola": "^2.15.3",
32
- "tslib": "^2.3.1"
32
+ "tslib": "^2.8.1"
33
33
  },
34
34
  "repository": {
35
35
  "type": "git",
@@ -39,5 +39,5 @@
39
39
  "publishConfig": {
40
40
  "access": "public"
41
41
  },
42
- "gitHead": "f52f52aa356a14a591ce6a1551f0c0391781d3f9"
42
+ "gitHead": "5ef35131a2b18fc635a5dca47647fa0438d21798"
43
43
  }