@genesislcap/foundation-events 14.302.1-alpha-475e82d.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 +13 -11
  26. package/docs/api-report.md.api.md +0 -466
package/docs/api/foundation-events.customevent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-events](./foundation-events.md) > [customEvent](./foundation-events.customevent.md)
4
4
 
5
- ## customEvent() function
5
+ ## customEvent variable
6
6
 
7
7
 
8
8
  **Signature:**
@@ -10,42 +10,3 @@
10
10
  ```typescript
11
11
  customEvent: <TEventDetail = void>(ctx: ExecutionContext) => CustomEvent<TEventDetail>
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
- ctx
35
-
36
-
37
- </td><td>
38
-
39
- ExecutionContext
40
-
41
-
42
- </td><td>
43
-
44
-
45
- </td></tr>
46
- </tbody></table>
47
-
48
- **Returns:**
49
-
50
- CustomEvent&lt;TEventDetail&gt;
51
-
package/docs/api/foundation-events.defaulteventemitterdi.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.defaulteventemitterdi.md CHANGED
@@ -15,33 +15,7 @@ export declare class DefaultEventEmitterDI<TEventDetailMap extends EventDetailMa
15
15
 
16
16
  ## Methods
17
17
 
18
- <table><thead><tr><th>
19
-
20
- Method
21
-
22
-
23
- </th><th>
24
-
25
- Modifiers
26
-
27
-
28
- </th><th>
29
-
30
- Description
31
-
32
-
33
- </th></tr></thead>
34
- <tbody><tr><td>
35
-
36
- [emit(args)](./foundation-events.defaulteventemitterdi.emit.md)
37
-
38
-
39
- </td><td>
40
-
41
-
42
- </td><td>
43
-
44
-
45
- </td></tr>
46
- </tbody></table>
18
+ | Method | Modifiers | Description |
19
+ | --- | --- | --- |
20
+ | [emit(args)](./foundation-events.defaulteventemitterdi.emit.md) | | |
47
21
 
package/docs/api/foundation-events.emitter.md CHANGED
@@ -2,11 +2,11 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [emitter](./foundation-events.emitter.md)
4
4
 
5
- ## emitter() function
5
+ ## emitter variable
6
6
 
7
7
  emitter function.
8
8
 
9
- This is the functional equivalent of the strongly typed `.emit` function created with the [EventEmitter()](./foundation-events.eventemitter.md) mixin.
9
+ This is the functional equivalent of the strongly typed `.emit` function created with the [EventEmitter](./foundation-events.eventemitter.md) mixin.
10
10
 
11
11
  **Signature:**
12
12
 
@@ -15,13 +15,10 @@ emitter: <TEventDetailMap extends EventDetailMap>() => {
15
15
  emit: <K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: HTMLElement, type: K, options?: EmitOptions] : [origin: HTMLElement, type: K, detail: TEventDetailMap[K], options?: EmitOptions]) => void;
16
16
  }
17
17
  ```
18
- **Returns:**
19
-
20
- { emit: &lt;K extends keyof TEventDetailMap&gt;(...args: TEventDetailMap\[K\] extends void ? \[origin: HTMLElement, type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[origin: HTMLElement, type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\]) =&gt; void; }
21
18
 
22
19
  ## Remarks
23
20
 
24
- This is useful if you need to emit an event from an arbitrary location. For example, if you want to emit an event from a button on a custom grid cell renderer you can use this to get strong typing rather than having to dependency inject a reference to the class which uses the [EventEmitter()](./foundation-events.eventemitter.md) mixin multiple levels into the renderer.
21
+ This is useful if you need to emit an event from an arbitrary location. For example, if you want to emit an event from a button on a custom grid cell renderer you can use this to get strong typing rather than having to dependency inject a reference to the class which uses the [EventEmitter](./foundation-events.eventemitter.md) mixin multiple levels into the renderer.
25
22
 
26
23
  ## Example
27
24