Class List<T>

Represends a generic doubly-linked list.

Type Parameters

Index

Constructors

constructor

new List<T>(): List<T>
Creates a new empty List instance.
Type Parameters
- T
Returns List<T>
- Defined in src/utils/list/List.ts:38

Accessors

first

get first(): undefined | Item<T>
Gets the first element in the list, or undefined if the list is empty.

Returns undefined | Item<T>
- Defined in src/utils/list/List.ts:16

last

get last(): undefined | Item<T>
Gets the last element in the list, or undefined if the list is empty.

Returns undefined | Item<T>
- Defined in src/utils/list/List.ts:24

length

get length(): number
Gets the number of elements in the list.

Returns number
- Defined in src/utils/list/List.ts:31

Methods

[iterator]

"[iterator]"(): IterableIterator<Item<T>>
Returns an iterator over the list items.

Returns IterableIterator<Item<T>>
- Defined in src/utils/list/List.ts:165

clear

clear(): void
Removes all elements from the list.

Returns void
- Defined in src/utils/list/List.ts:87

contains

contains(element: T): boolean
Determines whether the list contains the specified element.
Parameters
- element: T
  The value to check for.
Returns boolean
True if the element is found, otherwise false.
- Defined in src/utils/list/List.ts:113

find

find(element: T): undefined | Item<T>
Finds the first item whose stored value mathes the given element.
Parameters
- element: T
  The value to search for.
Returns undefined | Item<T>
The matching Item, or undefined if not found.
- Defined in src/utils/list/List.ts:99

forEach

forEach(
callbackfn: (value: T, i: number, list: List<T>) => void,
thisArg?: any,
): void
Performs the specified action for each element in a list.
Parameters
- callbackfn: (value: T, i: number, list: List<T>) => void
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the list.
- OptionalthisArg: any
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
- Defined in src/utils/list/List.ts:126

map

map<U>(
callbackfn: (value: T, index: number, list: List<T>) => U,
thisArg?: any,
): List<U>
Calls a defined callback function on each element of a list, and returns a list that contains the results.
Type Parameters
- U
Parameters
- callbackfn: (value: T, index: number, list: List<T>) => U
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the list.
- OptionalthisArg: any
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns List<U>
- Defined in src/utils/list/List.ts:147

pop

pop(): undefined | Item<T>
Removes and returns the last element of the list.

Returns undefined | Item<T>
The removed Item, or undefined if the list is empty.
- Defined in src/utils/list/List.ts:80

push

push(element: T): Item<T>
Inserts a new element to the end of the list.
Parameters
- element: T
  The element to insert.
Returns Item<T>
The created Item wrapping the element.
- Defined in src/utils/list/List.ts:62

shift

shift(): undefined | Item<T>
Removes and returns the first element of the list.

Returns undefined | Item<T>
The removed Item, or undefined if the list is empty.
- Defined in src/utils/list/List.ts:71

unshift

unshift(element: T): Item<T>
Inserts a new element at the beginning of the list.
Parameters
- element: T
  The element to insert.
Returns Item<T>
The created Item wrapping the element.
- Defined in src/utils/list/List.ts:52

Class List<T>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Returns List<T>

Accessors

first

Returns undefined | Item<T>

last

Returns undefined | Item<T>

length

Returns number

Methods

[iterator]

Returns IterableIterator<Item<T>>

clear

Returns void

contains

Parameters

Returns boolean

find

Parameters

Returns undefined | Item<T>

forEach

Parameters

Returns void

map

Type Parameters

Parameters

Returns List<U>

pop

Returns undefined | Item<T>

push

Parameters

Returns Item<T>

shift

Returns undefined | Item<T>

unshift

Parameters

Returns Item<T>

Settings

On This Page