@xylabs/telemetry 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 +187 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,13 +12,197 @@
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/telemetry**
21
+
22
+ ***
23
+
24
+ ## Functions
25
+
26
+ - [cloneContextWithoutSpan](#functions/cloneContextWithoutSpan)
27
+ - [span](#functions/span)
28
+ - [spanRoot](#functions/spanRoot)
29
+ - [spanAsync](#functions/spanAsync)
30
+ - [spanRootAsync](#functions/spanRootAsync)
31
+
32
+ ### functions
33
+
34
+ ### <a id="cloneContextWithoutSpan"></a>cloneContextWithoutSpan
35
+
36
+ [**@xylabs/telemetry**](#../README)
37
+
38
+ ***
39
+
40
+ ```ts
41
+ function cloneContextWithoutSpan(activeCtx, configKeys): Context;
42
+ ```
43
+
44
+ ## Parameters
45
+
46
+ ### activeCtx
47
+
48
+ `Context`
49
+
50
+ ### configKeys
51
+
52
+ `symbol`[] = `[]`
53
+
54
+ ## Returns
55
+
56
+ `Context`
57
+
58
+ ### <a id="span"></a>span
59
+
60
+ [**@xylabs/telemetry**](#../README)
61
+
62
+ ***
63
+
64
+ ```ts
65
+ function span<T>(
66
+ name,
67
+ fn,
68
+ tracer?): T;
69
+ ```
70
+
71
+ ## Type Parameters
72
+
73
+ ### T
74
+
75
+ `T`
76
+
77
+ ## Parameters
78
+
79
+ ### name
80
+
81
+ `string`
82
+
83
+ ### fn
84
+
85
+ () => `T`
86
+
87
+ ### tracer?
88
+
89
+ `Tracer`
90
+
91
+ ## Returns
92
+
93
+ `T`
94
+
95
+ ### <a id="spanAsync"></a>spanAsync
96
+
97
+ [**@xylabs/telemetry**](#../README)
98
+
99
+ ***
100
+
101
+ ```ts
102
+ function spanAsync<T>(
103
+ name,
104
+ fn,
105
+ tracer?): Promise<T>;
106
+ ```
107
+
108
+ ## Type Parameters
109
+
110
+ ### T
111
+
112
+ `T`
113
+
114
+ ## Parameters
115
+
116
+ ### name
117
+
118
+ `string`
119
+
120
+ ### fn
121
+
122
+ () => `Promise`\<`T`\>
123
+
124
+ ### tracer?
125
+
126
+ `Tracer`
127
+
128
+ ## Returns
129
+
130
+ `Promise`\<`T`\>
131
+
132
+ ### <a id="spanRoot"></a>spanRoot
133
+
134
+ [**@xylabs/telemetry**](#../README)
135
+
136
+ ***
137
+
138
+ ```ts
139
+ function spanRoot<T>(
140
+ name,
141
+ fn,
142
+ tracer?): T;
143
+ ```
144
+
145
+ ## Type Parameters
146
+
147
+ ### T
148
+
149
+ `T`
150
+
151
+ ## Parameters
152
+
153
+ ### name
154
+
155
+ `string`
156
+
157
+ ### fn
158
+
159
+ () => `T`
160
+
161
+ ### tracer?
162
+
163
+ `Tracer`
164
+
165
+ ## Returns
166
+
167
+ `T`
168
+
169
+ ### <a id="spanRootAsync"></a>spanRootAsync
170
+
171
+ [**@xylabs/telemetry**](#../README)
172
+
173
+ ***
174
+
175
+ ```ts
176
+ function spanRootAsync<T>(
177
+ name,
178
+ fn,
179
+ tracer?): Promise<T>;
180
+ ```
181
+
182
+ ## Type Parameters
183
+
184
+ ### T
185
+
186
+ `T`
187
+
188
+ ## Parameters
189
+
190
+ ### name
191
+
192
+ `string`
193
+
194
+ ### fn
195
+
196
+ () => `Promise`\<`T`\>
197
+
198
+ ### tracer?
199
+
200
+ `Tracer`
201
+
202
+ ## Returns
203
+
204
+ `Promise`\<`T`\>
20
205
 
21
- Coming Soon!
22
206
 
23
207
  Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
24
208
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/telemetry",
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
  "hex",
@@ -43,7 +43,7 @@
43
43
  ],
44
44
  "dependencies": {
45
45
  "@opentelemetry/api": "^1.9.0",
46
- "@xylabs/typeof": "^4.13.20"
46
+ "@xylabs/typeof": "^4.13.21"
47
47
  },
48
48
  "devDependencies": {
49
49
  "@xylabs/ts-scripts-yarn3": "^7.0.0",