@empathyco/x-components/docs/API-reference/api/x-components.wiremetadata.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [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

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[component?](./x-components.wiremetadata.component.md)


</td><td>


</td><td>

Component


</td><td>

_(Optional)_ The component instance that triggered the event emission.


</td></tr>
<tr><td>

[feature?](./x-components.wiremetadata.feature.md)


</td><td>


</td><td>

[QueryFeature](./x-components.queryfeature.md) \| [ResultFeature](./x-components.resultfeature.md)


</td><td>

_(Optional)_ The [QueryFeature](./x-components.queryfeature.md) that originated the event.


</td></tr>
<tr><td>

[id?](./x-components.wiremetadata.id.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ The id of the component origin.


</td></tr>
<tr><td>

[ignoreInModules?](./x-components.wiremetadata.ignoreinmodules.md)


</td><td>


</td><td>

[XModuleName](./x-components.xmodulename.md)<!-- -->\[\]


</td><td>

_(Optional)_ The event can be ignored if it is received in the wiring of the modules in the array.


</td></tr>
<tr><td>

[location?](./x-components.wiremetadata.location.md)


</td><td>


</td><td>

[FeatureLocation](./x-components.featurelocation.md)


</td><td>

_(Optional)_ The [FeatureLocation](./x-components.featurelocation.md) from where the event has been emitted.


</td></tr>
<tr><td>

[moduleName](./x-components.wiremetadata.modulename.md)


</td><td>


</td><td>

[XModuleName](./x-components.xmodulename.md) \| null


</td><td>

The [XModule](./x-components.xmodule.md) name that emitted the event or `null` if it has been emitted from an unknown module.


</td></tr>
<tr><td>

[oldValue?](./x-components.wiremetadata.oldvalue.md)


</td><td>


</td><td>

unknown


</td><td>

_(Optional)_ The old value of a watched selector triggering an emitter.


</td></tr>
<tr><td>

[priority?](./x-components.wiremetadata.priority.md)


</td><td>


</td><td>

Priority


</td><td>

_(Optional)_ The event priority to use when sorting the bus queue for event batching.


</td></tr>
<tr><td>

[replaceable?](./x-components.wiremetadata.replaceable.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ The event replaces an existing entry of the same event in the bus, placing this new one based on its priority.


</td></tr>
<tr><td>

[target?](./x-components.wiremetadata.target.md)


</td><td>


</td><td>

HTMLElement


</td><td>

_(Optional)_ The DOM element that triggered the event emission.


</td></tr>
</tbody></table>