@empathyco/x-components
Version:
Empathy X Components
20 lines (11 loc) • 716 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseXPriorityQueue](./x-components.basexpriorityqueue.md) > [peek](./x-components.basexpriorityqueue.peek.md)
## BaseXPriorityQueue.peek() method
Retrieves, but does not remove, the head [node](./x-components.xpriorityqueuenode.md) of the queue.
**Signature:**
```typescript
peek(): XPriorityQueueNode<SomeRecord, SomeData> | undefined;
```
**Returns:**
[XPriorityQueueNode](./x-components.xpriorityqueuenode.md)<!-- --><SomeRecord, SomeData> \| undefined
The head [node](./x-components.xpriorityqueuenode.md) of the queue.