UNPKG

@empathyco/x-components

Version:
166 lines (74 loc) 2.23 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseXPriorityQueueNode](./x-components.basexpriorityqueuenode.md) ## BaseXPriorityQueueNode class Default [XPriorityQueueNode](./x-components.xpriorityqueuenode.md) implementation. **Signature:** ```typescript export declare class BaseXPriorityQueueNode<SomeRecord extends Dictionary, SomeData extends Dictionary> implements XPriorityQueueNode<SomeRecord, SomeData> ``` **Implements:** [XPriorityQueueNode](./x-components.xpriorityqueuenode.md)<!-- -->&lt;SomeRecord, SomeData&gt; ## Constructors <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td> [(constructor)(key, priority, data)](./x-components.basexpriorityqueuenode._constructor_.md) </td><td> </td><td> Constructs a new instance of the `BaseXPriorityQueueNode` class </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [data](./x-components.basexpriorityqueuenode.data.md) </td><td> `readonly` </td><td> SomeData </td><td> </td></tr> <tr><td> [key](./x-components.basexpriorityqueuenode.key.md) </td><td> `readonly` </td><td> keyof SomeRecord </td><td> </td></tr> <tr><td> [priority](./x-components.basexpriorityqueuenode.priority.md) </td><td> `readonly` </td><td> number </td><td> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td> [toString()](./x-components.basexpriorityqueuenode.tostring.md) </td><td> </td><td> Returns a string representation of this object. The string representation consists of: its priority, enclosed in square brackets (`[]`<!-- -->), followed by its key, an arrow `(->)` and the data converted to a string using JSON.stringify. </td></tr> </tbody></table>