Class PriorityMutable<V>

Simple priority queue implementation. Higher numbers mean higher priority.

const pm = new PriorityMutable();

// Add items with a priority (higher numeric value = higher value)
pm.enqueueWithPriority(`hello`, 4);
pm.enqueueWithPriotity(`there`, 1);

Type Parameters

Hierarchy (View Summary)

QueueMutable<PriorityItem<V>>
- PriorityMutable

Implements

IPriorityQueueMutable<V>

Index

Accessors

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from QueueMutable.isDisposed
- Defined in packages/events/src/simple-event-emitter.ts:13

isEmpty

get isEmpty(): boolean
Returns true if queue is empty

Returns boolean
Implementation of IPriorityQueueMutable.isEmpty
Inherited from QueueMutable.isEmpty
- Defined in packages/collections/src/queue/queue-mutable.ts:126

isFull

get isFull(): boolean
Is queue full? Returns false if no capacity has been set

Returns boolean
Implementation of IPriorityQueueMutable.isFull
Inherited from QueueMutable.isFull
- Defined in packages/collections/src/queue/queue-mutable.ts:130

length

get length(): number
Number of items in queue

Returns number
Implementation of IPriorityQueueMutable.length
Inherited from QueueMutable.length
- Defined in packages/collections/src/queue/queue-mutable.ts:134

peek

get peek(): undefined | V
Returns front of queue (oldest item), or undefined if queue is empty

Returns undefined | V
Implementation of IPriorityQueueMutable.peek
Inherited from QueueMutable.peek
- Defined in packages/collections/src/queue/queue-mutable.ts:138

Constructors

constructor

new PriorityMutable<V>(
opts?: QueueOpts<Readonly<{ item: V; priority: number }>>,
): PriorityMutable<V>
Type Parameters
- V
Parameters
- opts: QueueOpts<Readonly<{ item: V; priority: number }>> = {}
Returns PriorityMutable<V>
Overrides QueueMutable.constructor
- Defined in packages/collections/src/queue/priority-mutable.ts:22

Methods

addEventListener

addEventListener<
    K extends
        keyof QueueMutableEvents<Readonly<{ item: V; priority: number }>>,
>(
    name: K,
    listener: (
        event: QueueMutableEvents<Readonly<{ item: V; priority: number }>>[K],
        sender: SimpleEventEmitter<
            QueueMutableEvents<Readonly<{ item: V; priority: number }>>,
        >,
    ) => void,
): void
Adds event listener.
Type Parameters
- K extends keyof QueueMutableEvents<Readonly<{ item: V; priority: number }>>
  Events
Parameters
- name: K
  Event name
- listener: (
      event: QueueMutableEvents<Readonly<{ item: V; priority: number }>>[K],
      sender: SimpleEventEmitter<
          QueueMutableEvents<Readonly<{ item: V; priority: number }>>,
      >,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed
Inherited from QueueMutable.addEventListener
- Defined in packages/events/src/simple-event-emitter.ts:39

at

at(index: number): V
Returns the item at given rank (0 being front of queue)
Parameters
- index: number
Returns V
Implementation of IPriorityQueueMutable.at
Inherited from QueueMutable.at
- Defined in packages/collections/src/queue/queue-mutable.ts:72

changePriority

changePriority(
    item: V,
    priority: number,
    addIfMissing?: boolean,
    eq?: IsEqual<V>,
): void
Parameters
- item: V
- priority: number
- addIfMissing: boolean = false
- Optionaleq: IsEqual<V>
Returns void
- Defined in packages/collections/src/queue/priority-mutable.ts:44

clear

clear(): void
Clears the queue

Returns void
Implementation of IPriorityQueueMutable.clear
Inherited from QueueMutable.clear
- Defined in packages/collections/src/queue/queue-mutable.ts:59

dequeue

dequeue(): undefined | Readonly<{ item: V; priority: number }>
Dequeues (removes oldest item / item at front of queue)

Use peek to look at the item at front of queue without removing it.

Returns undefined | Readonly<{ item: V; priority: number }>
Item, or undefined if queue is empty
Implementation of IPriorityQueueMutable.dequeue
Inherited from QueueMutable.dequeue
- Defined in packages/collections/src/queue/queue-mutable.ts:90

dequeueMax

dequeueMax(): undefined | V
Dequeues the item with highest priority.

Returns undefined | V
Implementation of IPriorityQueueMutable.dequeueMax
- Defined in packages/collections/src/queue/priority-mutable.ts:67

dequeueMin

dequeueMin(): undefined | V
Dequeues the item with the lowest priority.

Returns undefined | V
Implementation of IPriorityQueueMutable.dequeueMin
- Defined in packages/collections/src/queue/priority-mutable.ts:76

dispose

dispose(): void
Returns void
Inherited from QueueMutable.dispose
- Defined in packages/events/src/simple-event-emitter.ts:8

enqueue

enqueue(...toAdd: readonly Readonly<{ item: V; priority: number }>[]): number
Enqueues (adds items to back of queue). If a capacity is set, not all items might be added.
Parameters
- ...toAdd: readonly Readonly<{ item: V; priority: number }>[]
Returns number
How many items were added
Implementation of IPriorityQueueMutable.enqueue
Inherited from QueueMutable.enqueue
- Defined in packages/collections/src/queue/queue-mutable.ts:79

enqueueWithPriority

enqueueWithPriority(item: V, priority: number): void
Adds an item with a given priority
Parameters
- item: V
  Item
- priority: number
  Priority (higher numeric value means higher priority)
Returns void
- Defined in packages/collections/src/queue/priority-mutable.ts:39

`Protected`fireEvent

fireEvent<
    K extends
        keyof QueueMutableEvents<Readonly<{ item: V; priority: number }>>,
>(
    type: K,
    args: QueueMutableEvents<Readonly<{ item: V; priority: number }>>[K],
): void
Fire event
Type Parameters
- K extends keyof QueueMutableEvents<Readonly<{ item: V; priority: number }>>
Parameters
- type: K
  Type of event
- args: QueueMutableEvents<Readonly<{ item: V; priority: number }>>[K]
  Arguments for event
Returns void
Inherited from QueueMutable.fireEvent
- Defined in packages/events/src/simple-event-emitter.ts:23

`Protected`onClear

onClear(): void
Called when all data is cleared

Returns void
Inherited from QueueMutable.onClear
- Defined in packages/collections/src/queue/queue-mutable.ts:69

`Protected`onEnqueue

onEnqueue(
result: readonly Readonly<{ item: V; priority: number }>[],
attemptedToAdd: readonly Readonly<{ item: V; priority: number }>[],
): void
Parameters
- result: readonly Readonly<{ item: V; priority: number }>[]
- attemptedToAdd: readonly Readonly<{ item: V; priority: number }>[]
Returns void
Inherited from QueueMutable.onEnqueue
- Defined in packages/collections/src/queue/queue-mutable.ts:86

`Protected`onRemoved

onRemoved(
removed: readonly Readonly<{ item: V; priority: number }>[],
finalData: readonly Readonly<{ item: V; priority: number }>[],
): void
Parameters
- removed: readonly Readonly<{ item: V; priority: number }>[]
- finalData: readonly Readonly<{ item: V; priority: number }>[]
Returns void
Inherited from QueueMutable.onRemoved
- Defined in packages/collections/src/queue/queue-mutable.ts:100

peekMax

peekMax(): undefined | V
Peeks at the item with highest priority without removing it. undefined if queue is empty.

Returns undefined | V
Implementation of IPriorityQueueMutable.peekMax
- Defined in packages/collections/src/queue/priority-mutable.ts:84

peekMin

peekMin(): undefined | V
Peeks at the item with the lowest priority without removing it. undefined if queue is empty.

Returns undefined | V
Implementation of IPriorityQueueMutable.peekMin
- Defined in packages/collections/src/queue/priority-mutable.ts:91

removeEventListener

removeEventListener<
    K extends
        keyof QueueMutableEvents<Readonly<{ item: V; priority: number }>>,
>(
    type: K,
    listener: (
        event: QueueMutableEvents<Readonly<{ item: V; priority: number }>>[K],
        sender: SimpleEventEmitter<
            QueueMutableEvents<Readonly<{ item: V; priority: number }>>,
        >,
    ) => void,
): void
Remove event listener
Type Parameters
- K extends keyof QueueMutableEvents<Readonly<{ item: V; priority: number }>>
Parameters
- type: K
- listener: (
      event: QueueMutableEvents<Readonly<{ item: V; priority: number }>>[K],
      sender: SimpleEventEmitter<
          QueueMutableEvents<Readonly<{ item: V; priority: number }>>,
      >,
  ) => void
Returns void
Inherited from QueueMutable.removeEventListener
- Defined in packages/events/src/simple-event-emitter.ts:55

removeWhere

removeWhere(predicate: (item: V) => boolean): number
Removes values that match predicate.
Parameters
- predicate: (item: V) => boolean
Returns number
Returns number of items removed.
Implementation of IPriorityQueueMutable.removeWhere
Inherited from QueueMutable.removeWhere
- Defined in packages/collections/src/queue/queue-mutable.ts:109

toArray

toArray(): Readonly<{ item: V; priority: number }>[]
Return a copy of the array

Returns Readonly<{ item: V; priority: number }>[]
Implementation of IPriorityQueueMutable.toArray
Inherited from QueueMutable.toArray
- Defined in packages/collections/src/queue/queue-mutable.ts:122

Properties

data

data: readonly Readonly<{ item: V; priority: number }>[]

eq

eq: IsEqual<Readonly<{ item: V; priority: number }>>

`Readonly`options

options: QueueOpts<Readonly<{ item: V; priority: number }>>

Class PriorityMutable<V>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Properties

Accessors

isDisposed

Returns boolean

isEmpty

Returns boolean

isFull

Returns boolean

length

Returns number

peek

Returns undefined | V

Constructors

constructor

Type Parameters

Parameters

Returns PriorityMutable<V>

Methods

addEventListener

Type Parameters

Parameters

Returns void

Throws

at

Parameters

Returns V

changePriority

Parameters

Returns void

clear

Returns void

dequeue

Returns undefined | Readonly<{ item: V; priority: number }>

dequeueMax

Returns undefined | V

dequeueMin

Returns undefined | V

dispose

Returns void

enqueue

Parameters

Returns number

enqueueWithPriority

Parameters

Returns void

ProtectedfireEvent

Type Parameters

Parameters

Returns void

ProtectedonClear

Returns void

ProtectedonEnqueue

Parameters

Returns void

ProtectedonRemoved

Parameters

Returns void

peekMax

Returns undefined | V

peekMin

Returns undefined | V

removeEventListener

Type Parameters

Parameters

Returns void

removeWhere

Parameters

Returns number

toArray

Returns Readonly<{ item: V; priority: number }>[]

Properties

data

`Protected`fireEvent

`Protected`onClear

`Protected`onEnqueue

`Protected`onRemoved

`Readonly`options