Interface List<T>

Represents a linked list, that can be a SinglyLinkedList or a DoublyLinkedList.

Type parameters

T

Hierarchy

List

Implemented by

DoublyLinkedList

Index

Methods

Methods

filter

filter(callback: ListFilterer<T>): List<T>

- Defined in list/index.ts:105
Filters out elements and returns a new List The original Lise remains unaltered.

Parameters
- callback: ListFilterer<T>
  
  The filter function.
Returns List<T>

The new List

get

get(value: T): ListNode<T> | undefined

- Defined in list/index.ts:82
Returns the first encountered element with matching value.

Parameters
- value: T
  
  The tested value.
Returns ListNode<T> | undefined

The first matching ListNode, undefined if no match.

getAll

getAll(value: T): ListNode<T>[]

- Defined in list/index.ts:89
Returns an array of all encountered elements with matching value.

Parameters
- value: T
  
  The tested value.
Returns ListNode<T>[]

An array of matching elements.

has

has(value: T): boolean

- Defined in list/index.ts:75
Checks whether a value is present in the list.

Parameters
- value: T
  
  The tested value.
Returns boolean

true if the value is found, false otherwise

insertAfter

insertAfter(value: T, after: ListNode<T>): ListNode<T> | undefined

- Defined in list/index.ts:68
Inserts a value after a ListNode. It fails if it does not belong to the list.

Parameters
- value: T
  
  The value to be inserted.
- after: ListNode<T>
  
  The target ListNode.
Returns ListNode<T> | undefined

The inserted ListNode, or undefined if the insertion failed.

insertBefore

insertBefore(value: T, before: ListNode<T>): ListNode<T> | undefined

- Defined in list/index.ts:59
Inserts a value before a ListNode. It fails if it does not belong to the list.

Parameters
- value: T
  
  The value to be inserted.
- before: ListNode<T>
  
  The target ListNode.
Returns ListNode<T> | undefined

The inserted ListNode, or undefined if the insertion failed.

map

map<U>(callback: ListMapper<T, U>): List<U>

- Defined in list/index.ts:97
Applies a transformation on each element and returns a new List. The original List remains unaltered.

Type parameters
- U
Parameters
- callback: ListMapper<T, U>
  
  The map function.
Returns List<U>

The new List

pop

pop(): ListNode<T> | undefined

- Defined in list/index.ts:37
Removes the last element of the list.

Returns ListNode<T> | undefined

The removed ListNode or undefined if nothing was removed.

push

push(value: T): ListNode<T>

- Defined in list/index.ts:31
Adds a ListNode with input value at the end of the list.

Parameters
- value: T
  
  The value attached to the element.
Returns ListNode<T>

The added ListNode.

reduce

reduce<U>(callback: ListReducer<T, U>, initialValue: U): U

- Defined in list/index.ts:114
Accumulates the result of specific operation on each value and returns the accumulation as a single result. The original List remains unaltered.

Type parameters
- U
Parameters
- callback: ListReducer<T, U>
  
  The filter function.
- initialValue: U
Returns U

The new List.

shift

shift(): ListNode<T> | undefined

- Defined in list/index.ts:50
Removes the first element of the list.

Returns ListNode<T> | undefined

The removed element or undefined if nothing was removed.

toArray

toArray(): T[]

- Defined in list/index.ts:120
Creates an array from the List values.

Returns T[]

The array of List values.

unshift

unshift(value: T): ListNode<T>

- Defined in list/index.ts:44
Adds an element with input value at the front of the list.

Parameters
- value: T
  
  The value attached to the element.
Returns ListNode<T>

The added element.

Generated using TypeDoc