@genesislcap/foundation-events 14.302.0 → 14.302.1-alpha-d11831b.0

package/docs/api/foundation-events.eventemitterdi.emit.md

@@ -12,9 +12,37 @@ emit<K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ?
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  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)<!-- -->\] |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+args
+
+
+</td><td>
+
+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)<!-- -->\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-events.eventemitterdi.md

@@ -14,7 +14,7 @@ export interface EventEmitterDI<TEventDetailMap extends EventDetailMap>
 
 ## Remarks
 
-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.
+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.
 
 ## Example 1
 
@@ -42,7 +42,25 @@ export class MyComponent extends FASTElement {
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [emit(args)](./foundation-events.eventemitterdi.emit.md) |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[emit(args)](./foundation-events.eventemitterdi.emit.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-events.getbaseemitargs.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-events](./foundation-events.md) > [getBaseEmitArgs](./foundation-events.getbaseemitargs.md)
 
-## getBaseEmitArgs variable
+## getBaseEmitArgs() function
 
 
 **Signature:**
@@ -10,3 +10,42 @@
 ```typescript
 getBaseEmitArgs: (...args: unknown[]) => EmitArgs
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+args
+
+
+</td><td>
+
+unknown\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[EmitArgs](./foundation-events.emitargs.md)
+

package/docs/api/foundation-events.isemitoptions.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-events](./foundation-events.md) > [isEmitOptions](./foundation-events.isemitoptions.md)
 
-## isEmitOptions variable
+## isEmitOptions() function
 
 
 **Signature:**
@@ -10,3 +10,42 @@
 ```typescript
 isEmitOptions: (candidate: EmitOptions | any) => boolean
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+candidate
+
+
+</td><td>
+
+[EmitOptions](./foundation-events.emitoptions.md) \| any
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+boolean
+

package/docs/api/foundation-events.md

@@ -6,45 +6,322 @@
 
 ## Classes
 
-|  Class | Description |
-|  --- | --- |
-|  [DefaultEventEmitterDI](./foundation-events.defaulteventemitterdi.md) | Default EventEmitterDI. |
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[DefaultEventEmitterDI](./foundation-events.defaulteventemitterdi.md)
+
+
+</td><td>
+
+Default EventEmitterDI.
+
+
+</td></tr>
+</tbody></table>
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[createInputEmitter()](./foundation-events.createinputemitter.md)
+
+
+</td><td>
+
+`<input>` template emit helper.
+
+
+</td></tr>
+<tr><td>
+
+[createSelectEmitter()](./foundation-events.createselectemitter.md)
+
+
+</td><td>
+
+`<select>` template emit helper.
+
+
+</td></tr>
+<tr><td>
+
+[customEvent(ctx)](./foundation-events.customevent.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[emitter()](./foundation-events.emitter.md)
+
+
+</td><td>
+
+emitter function.
+
+This is the functional equivalent of the strongly typed `.emit` function created with the [EventEmitter()](./foundation-events.eventemitter.md) mixin.
+
+
+</td></tr>
+<tr><td>
+
+[EventEmitter(Target)](./foundation-events.eventemitter.md)
+
+
+</td><td>
+
+EventEmitter mixin.
+
+
+</td></tr>
+<tr><td>
+
+[getBaseEmitArgs(args)](./foundation-events.getbaseemitargs.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[isEmitOptions(candidate)](./foundation-events.isemitoptions.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[registerEmitter()](./foundation-events.registeremitter.md)
+
+
+</td><td>
+
+Register an emitter with the DI.
+
+
+</td></tr>
+</tbody></table>
 
 ## Interfaces
 
-|  Interface | Description |
-|  --- | --- |
-|  [EventEmitterDI](./foundation-events.eventemitterdi.md) | EventEmitterDI interface. |
-|  [TypedEmitter](./foundation-events.typedemitter.md) |  |
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[EventEmitterDI](./foundation-events.eventemitterdi.md)
+
+
+</td><td>
+
+EventEmitterDI interface.
+
+
+</td></tr>
+<tr><td>
+
+[TypedEmitter](./foundation-events.typedemitter.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
 
 ## Variables
 
-|  Variable | Description |
-|  --- | --- |
-|  [createInputEmitter](./foundation-events.createinputemitter.md) | <code>&lt;input&gt;</code> template emit helper. |
-|  [createSelectEmitter](./foundation-events.createselectemitter.md) | <code>&lt;select&gt;</code> template emit helper. |
-|  [customEvent](./foundation-events.customevent.md) |  |
-|  [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> |
-|  [EventEmitter](./foundation-events.eventemitter.md) | EventEmitter mixin. |
-|  [getBaseEmitArgs](./foundation-events.getbaseemitargs.md) |  |
-|  [isEmitOptions](./foundation-events.isemitoptions.md) |  |
-|  [logger](./foundation-events.logger.md) |  |
-|  [registerEmitter](./foundation-events.registeremitter.md) | Register an emitter with the DI. |
-|  [targetChecked](./foundation-events.targetchecked.md) |  |
-|  [targetFirstSelectedValue](./foundation-events.targetfirstselectedvalue.md) |  |
-|  [targetValue](./foundation-events.targetvalue.md) |  |
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[logger](./foundation-events.logger.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[targetChecked](./foundation-events.targetchecked.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[targetFirstSelectedValue](./foundation-events.targetfirstselectedvalue.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[targetValue](./foundation-events.targetvalue.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
 
 ## Type Aliases
 
-|  Type Alias | Description |
-|  --- | --- |
-|  [ConstructableTypedEventEmitter](./foundation-events.constructabletypedeventemitter.md) |  |
-|  [CustomEventMap](./foundation-events.customeventmap.md) |  |
-|  [EmitArgs](./foundation-events.emitargs.md) |  |
-|  [EmitOptions](./foundation-events.emitoptions.md) |  |
-|  [EmitOrigin](./foundation-events.emitorigin.md) |  |
-|  [EmitReturn](./foundation-events.emitreturn.md) |  |
-|  [EventDetailMap](./foundation-events.eventdetailmap.md) |  |
-|  [EventEmitterTarget](./foundation-events.eventemittertarget.md) |  |
-|  [KeysMatching](./foundation-events.keysmatching.md) |  |
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[ConstructableTypedEventEmitter](./foundation-events.constructabletypedeventemitter.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[CustomEventMap](./foundation-events.customeventmap.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[EmitArgs](./foundation-events.emitargs.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[EmitOptions](./foundation-events.emitoptions.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[EmitOrigin](./foundation-events.emitorigin.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[EmitReturn](./foundation-events.emitreturn.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[EventDetailMap](./foundation-events.eventdetailmap.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[EventEmitterTarget](./foundation-events.eventemittertarget.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[KeysMatching](./foundation-events.keysmatching.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-events.registeremitter.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-events](./foundation-events.md) > [registerEmitter](./foundation-events.registeremitter.md)
 
-## registerEmitter variable
+## registerEmitter() function
 
 Register an emitter with the DI.
 
@@ -11,3 +11,7 @@ Register an emitter with the DI.
 ```typescript
 registerEmitter: <TEventDetailMap extends EventDetailMap>() => import("@microsoft/fast-foundation").InterfaceSymbol<EventEmitterDI<TEventDetailMap>>
 ```
+**Returns:**
+
+import("@microsoft/fast-foundation").InterfaceSymbol&lt;[EventEmitterDI](./foundation-events.eventemitterdi.md)<!-- -->&lt;TEventDetailMap&gt;&gt;
+

package/docs/api/foundation-events.typedemitter._emit.md

@@ -12,9 +12,37 @@ $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] exte
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  args | TEventDetailMap\[K\] extends void ? \[type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+args
+
+
+</td><td>
+
+TEventDetailMap\[K\] extends void ? \[type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-events.typedemitter.md

@@ -13,7 +13,25 @@ export interface TypedEmitter<TEventDetailMap extends EventDetailMap>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [$emit(args)](./foundation-events.typedemitter._emit.md) |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[$emit(args)](./foundation-events.typedemitter._emit.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/index.md

@@ -6,7 +6,25 @@
 
 ## Packages
 
-|  Package | Description |
-|  --- | --- |
-|  [@genesislcap/foundation-events](./foundation-events.md) |  |
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[@genesislcap/foundation-events](./foundation-events.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>