@empathyco/x-components
Version:
Empathy X Components
30 lines (21 loc) • 2.43 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [WireMetadata](./x-components.wiremetadata.md)
## WireMetadata interface
The wires metadata includes more information about the emitted event, so then these events can be processed with more precision if needed.
**Signature:**
```typescript
export interface WireMetadata
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [component?](./x-components.wiremetadata.component.md) | | Component | _(Optional)_ The component instance that triggered the event emission. |
| [feature?](./x-components.wiremetadata.feature.md) | | [QueryFeature](./x-components.queryfeature.md) \| [ResultFeature](./x-components.resultfeature.md) | _(Optional)_ The [QueryFeature](./x-components.queryfeature.md) that originated the event. |
| [id?](./x-components.wiremetadata.id.md) | | string | _(Optional)_ The id of the component origin. |
| [ignoreInModules?](./x-components.wiremetadata.ignoreinmodules.md) | | [XModuleName](./x-components.xmodulename.md)<!-- -->\[\] | _(Optional)_ The event can be ignored if it is received in the wiring of the modules in the array. |
| [location?](./x-components.wiremetadata.location.md) | | [FeatureLocation](./x-components.featurelocation.md) | _(Optional)_ The [FeatureLocation](./x-components.featurelocation.md) from where the event has been emitted. |
| [moduleName](./x-components.wiremetadata.modulename.md) | | [XModuleName](./x-components.xmodulename.md) \| null | The [XModule](./x-components.xmodule.md) name that emitted the event or <code>null</code> if it has been emitted from an unknown module. |
| [oldValue?](./x-components.wiremetadata.oldvalue.md) | | unknown | _(Optional)_ The old value of a watched selector triggering an emitter. |
| [priority?](./x-components.wiremetadata.priority.md) | | Priority | _(Optional)_ The event priority to use when sorting the bus queue for event batching. |
| [replaceable?](./x-components.wiremetadata.replaceable.md) | | boolean | _(Optional)_ The event replaces an existing entry of the same event in the bus, placing this new one based on its priority. |
| [target?](./x-components.wiremetadata.target.md) | | HTMLElement | _(Optional)_ The DOM element that triggered the event emission. |