@genesislcap/foundation-events 14.302.1-alpha-945e484.0 → 14.302.1-alpha-ecc0cfb.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.
Files changed (26) hide show
  1. package/dist/dts/eventEmitter/emitterFunction.d.ts.map +1 -1
  2. package/dist/dts/eventEmitter/eventEmitterDI.d.ts.map +1 -1
  3. package/dist/dts/eventEmitter/eventEmitterMixin.d.ts +215 -256
  4. package/dist/dts/eventEmitter/eventEmitterMixin.d.ts.map +1 -1
  5. package/dist/dts/tsdoc-metadata.json +1 -1
  6. package/dist/dts/types.d.ts.map +1 -1
  7. package/dist/foundation-events.api.json +345 -962
  8. package/dist/foundation-events.d.ts +215 -256
  9. package/docs/api/foundation-events.createinputemitter.md +1 -4
  10. package/docs/api/foundation-events.createselectemitter.md +1 -4
  11. package/docs/api/foundation-events.customevent.md +1 -40
  12. package/docs/api/foundation-events.defaulteventemitterdi.emit.md +3 -31
  13. package/docs/api/foundation-events.defaulteventemitterdi.md +3 -29
  14. package/docs/api/foundation-events.emitter.md +3 -6
  15. package/docs/api/foundation-events.eventemitter.md +216 -297
  16. package/docs/api/foundation-events.eventemitterdi.emit.md +3 -31
  17. package/docs/api/foundation-events.eventemitterdi.md +4 -22
  18. package/docs/api/foundation-events.getbaseemitargs.md +1 -40
  19. package/docs/api/foundation-events.isemitoptions.md +1 -40
  20. package/docs/api/foundation-events.md +32 -309
  21. package/docs/api/foundation-events.registeremitter.md +1 -5
  22. package/docs/api/foundation-events.typedemitter._emit.md +3 -31
  23. package/docs/api/foundation-events.typedemitter.md +3 -21
  24. package/docs/api/index.md +3 -21
  25. package/package.json +11 -11
  26. package/docs/api-report.md.api.md +0 -466
package/docs/api/foundation-events.eventemitterdi.emit.md CHANGED
@@ -12,37 +12,9 @@ emit<K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ?
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- args
34
-
35
-
36
- </td><td>
37
-
38
- TEventDetailMap\[K\] extends void ? \[origin: [EmitOrigin](./foundation-events.emitorigin.md)<!-- -->, type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[origin: [EmitOrigin](./foundation-events.emitorigin.md)<!-- -->, type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\]
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | args | TEventDetailMap\[K\] extends void ? \[origin: [EmitOrigin](./foundation-events.emitorigin.md)<!-- -->, type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[origin: [EmitOrigin](./foundation-events.emitorigin.md)<!-- -->, type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] | |
46
18
 
47
19
  **Returns:**
48
20
 
package/docs/api/foundation-events.eventemitterdi.md CHANGED
@@ -14,7 +14,7 @@ export interface EventEmitterDI<TEventDetailMap extends EventDetailMap>
14
14
 
15
15
  ## Remarks
16
16
 
17
- A strongly typed event emitter with events typed to [EventDetailMap](./foundation-events.eventdetailmap.md) pairings. This is closely related to the [EventEmitter()](./foundation-events.eventemitter.md) mixin in terms of functionality, however its purpose is different. This allows you to create pre-configured EventEmitters that can be injected anywhere. These can emit typed events from an origin html element, without that element needing to be an actual . If you are starting out, we recommend using the [EventEmitter()](./foundation-events.eventemitter.md) mixin where possible.
17
+ A strongly typed event emitter with events typed to [EventDetailMap](./foundation-events.eventdetailmap.md) pairings. This is closely related to the [EventEmitter](./foundation-events.eventemitter.md) mixin in terms of functionality, however its purpose is different. This allows you to create pre-configured EventEmitters that can be injected anywhere. These can emit typed events from an origin html element, without that element needing to be an actual . If you are starting out, we recommend using the [EventEmitter](./foundation-events.eventemitter.md) mixin where possible.
18
18
 
19
19
  ## Example 1
20
20
 
@@ -42,25 +42,7 @@ export class MyComponent extends FASTElement {
42
42
 
43
43
  ## Methods
44
44
 
45
- <table><thead><tr><th>
46
-
47
- Method
48
-
49
-
50
- </th><th>
51
-
52
- Description
53
-
54
-
55
- </th></tr></thead>
56
- <tbody><tr><td>
57
-
58
- [emit(args)](./foundation-events.eventemitterdi.emit.md)
59
-
60
-
61
- </td><td>
62
-
63
-
64
- </td></tr>
65
- </tbody></table>
45
+ | Method | Description |
46
+ | --- | --- |
47
+ | [emit(args)](./foundation-events.eventemitterdi.emit.md) | |
66
48
 
package/docs/api/foundation-events.getbaseemitargs.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [getBaseEmitArgs](./foundation-events.getbaseemitargs.md)
4
4
 
5
- ## getBaseEmitArgs() function
5
+ ## getBaseEmitArgs variable
6
6
 
7
7
 
8
8
  **Signature:**
@@ -10,42 +10,3 @@
10
10
  ```typescript
11
11
  getBaseEmitArgs: (...args: unknown[]) => EmitArgs
12
12
  ```
13
-
14
- ## Parameters
15
-
16
- <table><thead><tr><th>
17
-
18
- Parameter
19
-
20
-
21
- </th><th>
22
-
23
- Type
24
-
25
-
26
- </th><th>
27
-
28
- Description
29
-
30
-
31
- </th></tr></thead>
32
- <tbody><tr><td>
33
-
34
- args
35
-
36
-
37
- </td><td>
38
-
39
- unknown\[\]
40
-
41
-
42
- </td><td>
43
-
44
-
45
- </td></tr>
46
- </tbody></table>
47
-
48
- **Returns:**
49
-
50
- [EmitArgs](./foundation-events.emitargs.md)
51
-
package/docs/api/foundation-events.isemitoptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [isEmitOptions](./foundation-events.isemitoptions.md)
4
4
 
5
- ## isEmitOptions() function
5
+ ## isEmitOptions variable
6
6
 
7
7
 
8
8
  **Signature:**
@@ -10,42 +10,3 @@
10
10
  ```typescript
11
11
  isEmitOptions: (candidate: EmitOptions | any) => boolean
12
12
  ```
13
-
14
- ## Parameters
15
-
16
- <table><thead><tr><th>
17
-
18
- Parameter
19
-
20
-
21
- </th><th>
22
-
23
- Type
24
-
25
-
26
- </th><th>
27
-
28
- Description
29
-
30
-
31
- </th></tr></thead>
32
- <tbody><tr><td>
33
-
34
- candidate
35
-
36
-
37
- </td><td>
38
-
39
- [EmitOptions](./foundation-events.emitoptions.md) \| any
40
-
41
-
42
- </td><td>
43
-
44
-
45
- </td></tr>
46
- </tbody></table>
47
-
48
- **Returns:**
49
-
50
- boolean
51
-
package/docs/api/foundation-events.md CHANGED
@@ -6,322 +6,45 @@
6
6
 
7
7
  ## Classes
8
8
 
9
- <table><thead><tr><th>
10
-
11
- Class
12
-
13
-
14
- </th><th>
15
-
16
- Description
17
-
18
-
19
- </th></tr></thead>
20
- <tbody><tr><td>
21
-
22
- [DefaultEventEmitterDI](./foundation-events.defaulteventemitterdi.md)
23
-
24
-
25
- </td><td>
26
-
27
- Default EventEmitterDI.
28
-
29
-
30
- </td></tr>
31
- </tbody></table>
32
-
33
- ## Functions
34
-
35
- <table><thead><tr><th>
36
-
37
- Function
38
-
39
-
40
- </th><th>
41
-
42
- Description
43
-
44
-
45
- </th></tr></thead>
46
- <tbody><tr><td>
47
-
48
- [createInputEmitter()](./foundation-events.createinputemitter.md)
49
-
50
-
51
- </td><td>
52
-
53
- `<input>` template emit helper.
54
-
55
-
56
- </td></tr>
57
- <tr><td>
58
-
59
- [createSelectEmitter()](./foundation-events.createselectemitter.md)
60
-
61
-
62
- </td><td>
63
-
64
- `<select>` template emit helper.
65
-
66
-
67
- </td></tr>
68
- <tr><td>
69
-
70
- [customEvent(ctx)](./foundation-events.customevent.md)
71
-
72
-
73
- </td><td>
74
-
75
-
76
-
77
- </td></tr>
78
- <tr><td>
79
-
80
- [emitter()](./foundation-events.emitter.md)
81
-
82
-
83
- </td><td>
84
-
85
- emitter function.
86
-
87
- This is the functional equivalent of the strongly typed `.emit` function created with the [EventEmitter()](./foundation-events.eventemitter.md) mixin.
88
-
89
-
90
- </td></tr>
91
- <tr><td>
92
-
93
- [EventEmitter(Target)](./foundation-events.eventemitter.md)
94
-
95
-
96
- </td><td>
97
-
98
- EventEmitter mixin.
99
-
100
-
101
- </td></tr>
102
- <tr><td>
103
-
104
- [getBaseEmitArgs(args)](./foundation-events.getbaseemitargs.md)
105
-
106
-
107
- </td><td>
108
-
109
-
110
-
111
- </td></tr>
112
- <tr><td>
113
-
114
- [isEmitOptions(candidate)](./foundation-events.isemitoptions.md)
115
-
116
-
117
- </td><td>
118
-
119
-
120
-
121
- </td></tr>
122
- <tr><td>
123
-
124
- [registerEmitter()](./foundation-events.registeremitter.md)
125
-
126
-
127
- </td><td>
128
-
129
- Register an emitter with the DI.
130
-
131
-
132
- </td></tr>
133
- </tbody></table>
9
+ | Class | Description |
10
+ | --- | --- |
11
+ | [DefaultEventEmitterDI](./foundation-events.defaulteventemitterdi.md) | Default EventEmitterDI. |
134
12
 
135
13
  ## Interfaces
136
14
 
137
- <table><thead><tr><th>
138
-
139
- Interface
140
-
141
-
142
- </th><th>
143
-
144
- Description
145
-
146
-
147
- </th></tr></thead>
148
- <tbody><tr><td>
149
-
150
- [EventEmitterDI](./foundation-events.eventemitterdi.md)
151
-
152
-
153
- </td><td>
154
-
155
- EventEmitterDI interface.
156
-
157
-
158
- </td></tr>
159
- <tr><td>
160
-
161
- [TypedEmitter](./foundation-events.typedemitter.md)
162
-
163
-
164
- </td><td>
165
-
166
-
167
-
168
- </td></tr>
169
- </tbody></table>
15
+ | Interface | Description |
16
+ | --- | --- |
17
+ | [EventEmitterDI](./foundation-events.eventemitterdi.md) | EventEmitterDI interface. |
18
+ | [TypedEmitter](./foundation-events.typedemitter.md) | |
170
19
 
171
20
  ## Variables
172
21
 
173
- <table><thead><tr><th>
174
-
175
- Variable
176
-
177
-
178
- </th><th>
179
-
180
- Description
181
-
182
-
183
- </th></tr></thead>
184
- <tbody><tr><td>
185
-
186
- [logger](./foundation-events.logger.md)
187
-
188
-
189
- </td><td>
190
-
191
-
192
-
193
- </td></tr>
194
- <tr><td>
195
-
196
- [targetChecked](./foundation-events.targetchecked.md)
197
-
198
-
199
- </td><td>
200
-
201
-
202
- </td></tr>
203
- <tr><td>
204
-
205
- [targetFirstSelectedValue](./foundation-events.targetfirstselectedvalue.md)
206
-
207
-
208
- </td><td>
209
-
210
-
211
-
212
- </td></tr>
213
- <tr><td>
214
-
215
- [targetValue](./foundation-events.targetvalue.md)
216
-
217
-
218
- </td><td>
219
-
220
-
221
-
222
- </td></tr>
223
- </tbody></table>
22
+ | Variable | Description |
23
+ | --- | --- |
24
+ | [createInputEmitter](./foundation-events.createinputemitter.md) | <code>&lt;input&gt;</code> template emit helper. |
25
+ | [createSelectEmitter](./foundation-events.createselectemitter.md) | <code>&lt;select&gt;</code> template emit helper. |
26
+ | [customEvent](./foundation-events.customevent.md) | |
27
+ | [emitter](./foundation-events.emitter.md) | <p>emitter function.</p><p>This is the functional equivalent of the strongly typed <code>.emit</code> function created with the [EventEmitter](./foundation-events.eventemitter.md) mixin.</p> |
28
+ | [EventEmitter](./foundation-events.eventemitter.md) | EventEmitter mixin. |
29
+ | [getBaseEmitArgs](./foundation-events.getbaseemitargs.md) | |
30
+ | [isEmitOptions](./foundation-events.isemitoptions.md) | |
31
+ | [logger](./foundation-events.logger.md) | |
32
+ | [registerEmitter](./foundation-events.registeremitter.md) | Register an emitter with the DI. |
33
+ | [targetChecked](./foundation-events.targetchecked.md) | |
34
+ | [targetFirstSelectedValue](./foundation-events.targetfirstselectedvalue.md) | |
35
+ | [targetValue](./foundation-events.targetvalue.md) | |
224
36
 
225
37
  ## Type Aliases
226
38
 
227
- <table><thead><tr><th>
228
-
229
- Type Alias
230
-
231
-
232
- </th><th>
233
-
234
- Description
235
-
236
-
237
- </th></tr></thead>
238
- <tbody><tr><td>
239
-
240
- [ConstructableTypedEventEmitter](./foundation-events.constructabletypedeventemitter.md)
241
-
242
-
243
- </td><td>
244
-
245
-
246
- </td></tr>
247
- <tr><td>
248
-
249
- [CustomEventMap](./foundation-events.customeventmap.md)
250
-
251
-
252
- </td><td>
253
-
254
-
255
-
256
- </td></tr>
257
- <tr><td>
258
-
259
- [EmitArgs](./foundation-events.emitargs.md)
260
-
261
-
262
- </td><td>
263
-
264
-
265
-
266
- </td></tr>
267
- <tr><td>
268
-
269
- [EmitOptions](./foundation-events.emitoptions.md)
270
-
271
-
272
- </td><td>
273
-
274
-
275
-
276
- </td></tr>
277
- <tr><td>
278
-
279
- [EmitOrigin](./foundation-events.emitorigin.md)
280
-
281
-
282
- </td><td>
283
-
284
-
285
-
286
- </td></tr>
287
- <tr><td>
288
-
289
- [EmitReturn](./foundation-events.emitreturn.md)
290
-
291
-
292
- </td><td>
293
-
294
-
295
-
296
- </td></tr>
297
- <tr><td>
298
-
299
- [EventDetailMap](./foundation-events.eventdetailmap.md)
300
-
301
-
302
- </td><td>
303
-
304
-
305
-
306
- </td></tr>
307
- <tr><td>
308
-
309
- [EventEmitterTarget](./foundation-events.eventemittertarget.md)
310
-
311
-
312
- </td><td>
313
-
314
-
315
- </td></tr>
316
- <tr><td>
317
-
318
- [KeysMatching](./foundation-events.keysmatching.md)
319
-
320
-
321
- </td><td>
322
-
323
-
324
-
325
- </td></tr>
326
- </tbody></table>
39
+ | Type Alias | Description |
40
+ | --- | --- |
41
+ | [ConstructableTypedEventEmitter](./foundation-events.constructabletypedeventemitter.md) | |
42
+ | [CustomEventMap](./foundation-events.customeventmap.md) | |
43
+ | [EmitArgs](./foundation-events.emitargs.md) | |
44
+ | [EmitOptions](./foundation-events.emitoptions.md) | |
45
+ | [EmitOrigin](./foundation-events.emitorigin.md) | |
46
+ | [EmitReturn](./foundation-events.emitreturn.md) | |
47
+ | [EventDetailMap](./foundation-events.eventdetailmap.md) | |
48
+ | [EventEmitterTarget](./foundation-events.eventemittertarget.md) | |
49
+ | [KeysMatching](./foundation-events.keysmatching.md) | |
327
50
 
package/docs/api/foundation-events.registeremitter.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [registerEmitter](./foundation-events.registeremitter.md)
4
4
 
5
- ## registerEmitter() function
5
+ ## registerEmitter variable
6
6
 
7
7
  Register an emitter with the DI.
8
8
 
@@ -11,7 +11,3 @@ Register an emitter with the DI.
11
11
  ```typescript
12
12
  registerEmitter: <TEventDetailMap extends EventDetailMap>() => import("@microsoft/fast-foundation").InterfaceSymbol<EventEmitterDI<TEventDetailMap>>
13
13
  ```
14
- **Returns:**
15
-
16
- import("@microsoft/fast-foundation").InterfaceSymbol&lt;[EventEmitterDI](./foundation-events.eventemitterdi.md)<!-- -->&lt;TEventDetailMap&gt;&gt;
17
-
package/docs/api/foundation-events.typedemitter._emit.md CHANGED
@@ -12,37 +12,9 @@ $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] exte
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- args
34
-
35
-
36
- </td><td>
37
-
38
- TEventDetailMap\[K\] extends void ? \[type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\]
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | args | TEventDetailMap\[K\] extends void ? \[type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] | |
46
18
 
47
19
  **Returns:**
48
20
 
package/docs/api/foundation-events.typedemitter.md CHANGED
@@ -13,25 +13,7 @@ export interface TypedEmitter<TEventDetailMap extends EventDetailMap>
13
13
 
14
14
  ## Methods
15
15
 
16
- <table><thead><tr><th>
17
-
18
- Method
19
-
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
-
26
- </th></tr></thead>
27
- <tbody><tr><td>
28
-
29
- [$emit(args)](./foundation-events.typedemitter._emit.md)
30
-
31
-
32
- </td><td>
33
-
34
-
35
- </td></tr>
36
- </tbody></table>
16
+ | Method | Description |
17
+ | --- | --- |
18
+ | [$emit(args)](./foundation-events.typedemitter._emit.md) | |
37
19
 
package/docs/api/index.md CHANGED
@@ -6,25 +6,7 @@
6
6
 
7
7
  ## Packages
8
8
 
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-events](./foundation-events.md)
23
-
24
-
25
- </td><td>
26
-
27
-
28
- </td></tr>
29
- </tbody></table>
9
+ | Package | Description |
10
+ | --- | --- |
11
+ | [@genesislcap/foundation-events](./foundation-events.md) | |
30
12
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-events",
3
3
  "description": "Genesis Foundation Events",
4
- "version": "14.302.1-alpha-945e484.0",
4
+ "version": "14.302.1-alpha-ecc0cfb.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -49,20 +49,20 @@
49
49
  }
50
50
  },
51
51
  "devDependencies": {
52
- "@genesislcap/foundation-testing": "14.302.1-alpha-945e484.0",
53
- "@genesislcap/genx": "14.302.1-alpha-945e484.0",
54
- "@genesislcap/rollup-builder": "14.302.1-alpha-945e484.0",
55
- "@genesislcap/ts-builder": "14.302.1-alpha-945e484.0",
56
- "@genesislcap/uvu-playwright-builder": "14.302.1-alpha-945e484.0",
57
- "@genesislcap/vite-builder": "14.302.1-alpha-945e484.0",
58
- "@genesislcap/webpack-builder": "14.302.1-alpha-945e484.0",
52
+ "@genesislcap/foundation-testing": "14.302.1-alpha-ecc0cfb.0",
53
+ "@genesislcap/genx": "14.302.1-alpha-ecc0cfb.0",
54
+ "@genesislcap/rollup-builder": "14.302.1-alpha-ecc0cfb.0",
55
+ "@genesislcap/ts-builder": "14.302.1-alpha-ecc0cfb.0",
56
+ "@genesislcap/uvu-playwright-builder": "14.302.1-alpha-ecc0cfb.0",
57
+ "@genesislcap/vite-builder": "14.302.1-alpha-ecc0cfb.0",
58
+ "@genesislcap/webpack-builder": "14.302.1-alpha-ecc0cfb.0",
59
59
  "rimraf": "^5.0.0"
60
60
  },
61
61
  "dependencies": {
62
- "@genesislcap/foundation-logger": "14.302.1-alpha-945e484.0",
62
+ "@genesislcap/foundation-logger": "14.302.1-alpha-ecc0cfb.0",
63
63
  "@microsoft/fast-element": "1.14.0",
64
64
  "@microsoft/fast-foundation": "2.49.6",
65
- "tslib": "^2.8.1"
65
+ "tslib": "^2.3.1"
66
66
  },
67
67
  "repository": {
68
68
  "type": "git",
@@ -72,5 +72,5 @@
72
72
  "publishConfig": {
73
73
  "access": "public"
74
74
  },
75
- "gitHead": "5ef35131a2b18fc635a5dca47647fa0438d21798"
75
+ "gitHead": "dad34f09069fa189f6d6855903eed9a431fdbab1"
76
76
  }