Class default<T>

A doubly (bidirectional) linked list. Acts as a safe, value focused wrapper for a linked-node-list.

Type Parameters

T

Hierarchy

default<T>
- default

Index

Constructors

constructor

new default<T>(initialValues?: null | Iterable<T>, equalityComparer?: EqualityComparison<T>): default<T>
Type Parameters
- T
Parameters
- Optional initialValues: null | Iterable<T>
- equalityComparer: EqualityComparison<T> = areEqual
Returns default<T>
Overrides CollectionBase<T>.constructor
- Defined in LinkedList.ts:139

Accessors

first

get first(): undefined | LinkedListNode<T>
Returns the first node or undefined if the list is empty.

Returns undefined | LinkedListNode<T>
- Defined in LinkedList.ts:150

firstValue

get firstValue(): undefined | T
Returns the first value or undefined if the list is empty.

Returns undefined | T
- Defined in LinkedList.ts:158

last

get last(): undefined | LinkedListNode<T>
Returns the last node or undefined if the list is empty.

Returns undefined | LinkedListNode<T>
- Defined in LinkedList.ts:166

lastValue

get lastValue(): undefined | T
Returns the last value or undefined if the list is empty.

Returns undefined | T
- Defined in LinkedList.ts:174

reversed

get reversed(): ExtendedIterable<T>
Iterable for iterating this collection in reverse order.

Returns

Returns ExtendedIterable<T>
- Defined in LinkedList.ts:391

version

get version(): number
The version number used to track changes.

Returns

Returns number
Overrides CollectionBase.version
- Defined in LinkedList.ts:183

Methods

`Protected` _addInternal

_addInternal(item: T): boolean
Parameters
- item: T
Returns boolean
Overrides CollectionBase._addInternal
- Defined in LinkedList.ts:406

`Protected` _clearInternal

_clearInternal(): number
Returns number
Overrides CollectionBase._clearInternal
- Defined in LinkedList.ts:430

`Protected` _getIterator

_getIterator(): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Overrides CollectionBase._getIterator
- Defined in LinkedList.ts:377

`Protected` _removeInternal

_removeInternal(item: T, max?: number): number
Parameters
- item: T
- max: number = Infinity
Returns number
Overrides CollectionBase._removeInternal
- Defined in LinkedList.ts:412

addAfter

addAfter(after: LinkedListNode<T>, item: T): default<T>
Adds a item after the specified node.

Returns
Parameters
- after: LinkedListNode<T>
  
  The node to precede the item.
- item: T
  
  The value to insert after the node.
Returns default<T>
- Defined in LinkedList.ts:341

addBefore

addBefore(before: LinkedListNode<T>, item: T): default<T>
Adds a item before the specified node.

Returns
Parameters
- before: LinkedListNode<T>
  
  The node to follow the item.
- item: T
  
  The value to insert before the node.
Returns default<T>
- Defined in LinkedList.ts:328

addFirst

addFirst(item: T): default<T>
Adds to specified item to the beginning of the list.

Returns
Parameters
- item: T
Returns default<T>
- Defined in LinkedList.ts:248

addLast

addLast(item: T): default<T>
Adds to specified item to the end of the list.

Returns
Parameters
- item: T
Returns default<T>
- Defined in LinkedList.ts:259

assertVersion

assertVersion(version: number): true
Throws if the provided version does not match the current one.

Returns
Parameters
- version: number
Returns true
Overrides CollectionBase.assertVersion
- Defined in LinkedList.ts:363

find

find(item: T): undefined | LinkedListNode<T>
Iterates the list returns the the first node that matches the value specified. Returns undefined if not found.

Returns
The node matching the item or undefined if not found
Parameters
- item: T
Returns undefined | LinkedListNode<T>
- Defined in LinkedList.ts:226

findLast

findLast(item: T): undefined | LinkedListNode<T>
Iterates the list in reverse returns the the first node that matches the value specified. Returns undefined if not found.

Returns
The node matching the item or undefined if not found
Parameters
- item: T
Returns undefined | LinkedListNode<T>
- Defined in LinkedList.ts:237

getCount

getCount(): number
Gets the number of nodes in the list.

Returns

Returns number
Overrides CollectionBase.getCount
- Defined in LinkedList.ts:372

getNodeAt

getNodeAt(index: number): undefined | LinkedListNode<T>
Iterates the list returns the the node at the index requested. Returns undefined if the index is out of range.

Returns
The node at the index requested or undefined.
Parameters
- index: number
Returns undefined | LinkedListNode<T>
- Defined in LinkedList.ts:215

getValueAt

getValueAt(index: number): undefined | T
Iterates the list returns the value of the node at the index requested. Returns undefined if the index is out of range.

Returns
The value at the index requested or undefined.
Parameters
- index: number
Returns undefined | T
- Defined in LinkedList.ts:204

incrementVersion

incrementVersion(): number
Increments the collection version. Useful for tracking changes.

Returns
The new version.

Returns number
Overrides CollectionBase.incrementVersion
- Defined in LinkedList.ts:353

removeAt

removeAt(index: number): boolean
Removes the node at the specified index.

Returns
True if the node was removed. False if the index was out of range.
Parameters
- index: number
Returns boolean
- Defined in LinkedList.ts:307

removeFirst

removeFirst(): boolean
Removes the first node.

Returns
True if the node was removed. False if the list is empty.

Returns boolean
- Defined in LinkedList.ts:278

removeLast

removeLast(): boolean
Removes the last node.

Returns
True if the node was removed. False if the list is empty.

Returns boolean
- Defined in LinkedList.ts:297

removeNode

removeNode(node: LinkedListNode<T>): boolean
Removes the node specified.

Returns
True if the node was removed. False if not found (already removed).
Parameters
- node: LinkedListNode<T>
Returns boolean
- Defined in LinkedList.ts:317

removeOnce

removeOnce(item: T): boolean
Iterates the list and finds the first node that matches the provided value and removes it.

Returns
True if found and removes, otherwise false.
Parameters
- item: T
  
  The value to remove.
Returns boolean
- Defined in LinkedList.ts:193

takeFirstValue

takeFirstValue(): undefined | T
Removes the first node and returns its value.

Returns
The value of the first node or undefined if the list is empty.

Returns undefined | T
- Defined in LinkedList.ts:268

takeLastValue

takeLastValue(): undefined | T
Removes the last node and returns its value.

Returns
The value of the last node or undefined if the list is empty.

Returns undefined | T
- Defined in LinkedList.ts:287

Generated using TypeDoc