@xylabs/log 4.13.20 → 4.13.21

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 (2) hide show
  1. package/README.md +137 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -12,13 +12,147 @@
12
12
  [![snyk-badge][]][snyk-link]
13
13
  [![socket-badge][]][socket-link]
14
14
 
15
- Version: 4.13.19
16
15
 
17
16
  Base functionality used throughout XY Labs TypeScript/JavaScript libraries
18
17
 
19
- ## Documentation
18
+ ## API Documentation
19
+
20
+ **@xylabs/log**
21
+
22
+ ***
23
+
24
+ ## Classes
25
+
26
+ - [~~Log~~](#classes/Log)
27
+
28
+ ### classes
29
+
30
+ ### <a id="Log"></a>Log
31
+
32
+ [**@xylabs/log**](#../README)
33
+
34
+ ***
35
+
36
+ ## Deprecated
37
+
38
+ use @xylabs/logger instead
39
+
40
+ ## Constructors
41
+
42
+ ### Constructor
43
+
44
+ ```ts
45
+ new Log(config): Log;
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+ #### config
51
+
52
+ `LogConfig`
53
+
54
+ ### Returns
55
+
56
+ `Log`
57
+
58
+ ## Properties
59
+
60
+ ### ~~config~~
61
+
62
+ ```ts
63
+ protected config: LogConfig;
64
+ ```
65
+
66
+ ## Methods
67
+
68
+ ### ~~debug()~~
69
+
70
+ ```ts
71
+ debug(...params): void;
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ #### params
77
+
78
+ ...`any`[]
79
+
80
+ ### Returns
81
+
82
+ `void`
83
+
84
+ ***
85
+
86
+ ### ~~error()~~
87
+
88
+ ```ts
89
+ error(...params): void;
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ #### params
95
+
96
+ ...`any`[]
97
+
98
+ ### Returns
99
+
100
+ `void`
101
+
102
+ ***
103
+
104
+ ### ~~info()~~
105
+
106
+ ```ts
107
+ info(...params): void;
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ #### params
113
+
114
+ ...`any`[]
115
+
116
+ ### Returns
117
+
118
+ `void`
119
+
120
+ ***
121
+
122
+ ### ~~log()~~
123
+
124
+ ```ts
125
+ log(...params): void;
126
+ ```
127
+
128
+ ### Parameters
129
+
130
+ #### params
131
+
132
+ ...`any`[]
133
+
134
+ ### Returns
135
+
136
+ `void`
137
+
138
+ ***
139
+
140
+ ### ~~warn()~~
141
+
142
+ ```ts
143
+ warn(...params): void;
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ #### params
149
+
150
+ ...`any`[]
151
+
152
+ ### Returns
153
+
154
+ `void`
20
155
 
21
- Coming Soon!
22
156
 
23
157
  Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
24
158
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/log",
3
- "version": "4.13.20",
3
+ "version": "4.13.21",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "log",