@empathyco/x-components
Version:
Empathy X Components
24 lines (15 loc) • 1.8 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XPriorityQueueNodeData](./x-components.xpriorityqueuenodedata.md)
## XPriorityQueueNodeData interface
Represents the [queue node data](./x-components.xpriorityqueuenode.data.md) in the [priority queue](./x-components.xpriorityqueue.md) of a [XPriorityBus](./x-components.xprioritybus.md)<!-- -->.
**Signature:**
```typescript
export interface XPriorityQueueNodeData<SomeEvents extends Dictionary, SomeEventMetadata extends Dictionary, SomeEvent extends keyof SomeEvents = keyof SomeEvents>
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [eventMetadata](./x-components.xpriorityqueuenodedata.eventmetadata.md) | | SomeEventMetadata | The event metadata. |
| [eventPayload](./x-components.xpriorityqueuenodedata.eventpayload.md) | | [EventPayload](./x-components.eventpayload.md)<!-- --><SomeEvents, SomeEvent> | The event payload. |
| [replaceable](./x-components.xpriorityqueuenodedata.replaceable.md) | | boolean | Flag determining if an event is replaceable or not. If a node is replaceable, and an event with the same key is inserted, then, the replaceable event is removed from the key, and the new one is inserted at its corresponding position. |
| [resolve](./x-components.xpriorityqueuenodedata.resolve.md) | | (value: [EmittedData](./x-components.emitteddata.md)<!-- --><SomeEvents, SomeEvent, SomeEventMetadata> \| PromiseLike<[EmittedData](./x-components.emitteddata.md)<!-- --><SomeEvents, SomeEvent, SomeEventMetadata>>) => void | The resolve function of the promise to be called the moment the event is emitted. |