Class PrioritizedList<DataClass>

Implements the PrioritizedList class

Type Parameters

DataClass
The class of data stored in the list

Hierarchy (View Summary)

PrioritizedList

Index

Constructors

Properties

items DEFAULTPRIORITY

Methods

[iterator] add remove

Constructors

constructor

new PrioritizedList<DataClass>(): PrioritizedList<DataClass>
Type Parameters
- DataClass
Returns PrioritizedList<DataClass>
- Defined in ts/util/PrioritizedList.ts:63

Properties

`Protected`items

items: PrioritizedListItem<DataClass>[] = []

The list of items, sorted by priority (smallest number first)

`Static`DEFAULTPRIORITY

DEFAULTPRIORITY: number = 5

The default priority for items added to the list

Methods

[iterator]

"[iterator]"(): Iterator<PrioritizedListItem<DataClass>>
Make the list iterable, and return the data for the items in the list

Returns Iterator<PrioritizedListItem<DataClass>>
The object containing the iterator's next() function
- Defined in ts/util/PrioritizedList.ts:72

add

add(item: DataClass, priority?: number): DataClass
Add an item to the list
Parameters
- item: DataClass
  The data for the item to be added
- priority: number = PrioritizedList.DEFAULTPRIORITY
  The priority for the item
Returns DataClass
The data itself
- Defined in ts/util/PrioritizedList.ts:89

remove

remove(item: DataClass): PrioritizedList<DataClass>
Remove an item from the list
Parameters
- item: DataClass
  The data for the item to be removed
Returns PrioritizedList<DataClass>
The list (for chaining of calls)
- Defined in ts/util/PrioritizedList.ts:107