@genesislcap/foundation-events 14.408.0 → 14.409.0

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

@@ -1,51 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [isEmitOptions](./foundation-events.isemitoptions.md)
-
-## isEmitOptions() function
-
-
-**Signature:**
-
-```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.keysmatching.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [KeysMatching](./foundation-events.keysmatching.md)
-
-## KeysMatching type
-
-
-**Signature:**
-
-```typescript
-export type KeysMatching<T, V> = {
-    [K in keyof T]-?: T[K] extends V ? K : never;
-}[keyof T];
-```

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [logger](./foundation-events.logger.md)
-
-## logger variable
-
-
-**Signature:**
-
-```typescript
-logger: import("@genesislcap/foundation-logger").Logger
-```

package/docs/api/foundation-events.md

@@ -1,327 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md)
-
-## foundation-events package
-
-## Classes
-
-<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
-
-<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
-
-<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
-
-<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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [registerEmitter](./foundation-events.registeremitter.md)
-
-## registerEmitter() function
-
-Register an emitter with the DI.
-
-**Signature:**
-
-```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.targetchecked.md

@@ -1,28 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [targetChecked](./foundation-events.targetchecked.md)
-
-## targetChecked variable
-
-**Signature:**
-
-```typescript
-targetChecked: ValueGetter
-```
-
-## Example
-
-
-```ts
-import { targetChecked } from '@genesislcap/foundation-events';
-...
-<${checkboxTag}
-  ?checked="${(x) => x.store.formEntry.showPassword}"
-  @change="${(x, c) => x.$emit('auth-showPassword-changed', targetChecked(c))}"
-  name="show-password"
-  data-test-id="show-password"
->
-  Show Password
-</${checkboxTag}>
-```
-

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [targetFirstSelectedValue](./foundation-events.targetfirstselectedvalue.md)
-
-## targetFirstSelectedValue variable
-
-
-**Signature:**
-
-```typescript
-targetFirstSelectedValue: ValueGetter
-```

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [targetValue](./foundation-events.targetvalue.md)
-
-## targetValue variable
-
-
-**Signature:**
-
-```typescript
-targetValue: ValueGetter
-```

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

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [TypedEmitter](./foundation-events.typedemitter.md) &gt; [$emit](./foundation-events.typedemitter._emit.md)
-
-## TypedEmitter.$emit() method
-
-**Signature:**
-
-```typescript
-$emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
-```
-
-## Parameters
-
-<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:**
-
-[EmitReturn](./foundation-events.emitreturn.md)
-

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

@@ -1,37 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [TypedEmitter](./foundation-events.typedemitter.md)
-
-## TypedEmitter interface
-
-
-**Signature:**
-
-```typescript
-export interface TypedEmitter<TEventDetailMap extends EventDetailMap> 
-```
-
-## Methods
-
-<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

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<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>
-