LinkedList

v0.0.8tested

Doubly linked list with O(1) push/pop on both ends and O(1) insert/remove by node reference

Signature

class LinkedList<T> implements LinkedListLike<T>

Type Parameters

T

Properties

Property	Type	Default	Description
`length`readonly	`number`	—	Gets the number of elements in the list
`isEmpty`readonly	`boolean`	—	Checks if the list is empty
`head`readonly	`LinkedListNode<T> \| undefined`	—	Gets the first node
`tail`readonly	`LinkedListNode<T> \| undefined`	—	Gets the last node

Methods

pushBack

Appends a value to the end of the list

public pushBack(value: T): LinkedListNode<T>

Parameter	Type	Default	Description
`value`	`T`	—	The value to append

ReturnsLinkedListNode<T>The created node

pushFront

Prepends a value to the beginning of the list

public pushFront(value: T): LinkedListNode<T>

Parameter	Type	Default	Description
`value`	`T`	—	The value to prepend

ReturnsLinkedListNode<T>The created node

popBack

Removes and returns the last value

public popBack(): T | undefined

ReturnsT | undefinedThe last value, or `undefined` if the list is empty

popFront

Removes and returns the first value

public popFront(): T | undefined

ReturnsT | undefinedThe first value, or `undefined` if the list is empty

peekBack

Returns the last value without removing it

public peekBack(): T | undefined

ReturnsT | undefinedThe last value, or `undefined` if the list is empty

peekFront

Returns the first value without removing it

public peekFront(): T | undefined

ReturnsT | undefinedThe first value, or `undefined` if the list is empty

insertBefore

Inserts a value before the given node

public insertBefore(node: LinkedListNode<T>, value: T): LinkedListNode<T>

Parameter	Type	Default	Description
`node`	`LinkedListNode<T>`	—	The reference node
`value`	`T`	—	The value to insert

ReturnsLinkedListNode<T>The created node

insertAfter

Inserts a value after the given node

public insertAfter(node: LinkedListNode<T>, value: T): LinkedListNode<T>

Parameter	Type	Default	Description
`node`	`LinkedListNode<T>`	—	The reference node
`value`	`T`	—	The value to insert

ReturnsLinkedListNode<T>The created node

remove

Removes a node from the list by reference in O(1)

public remove(node: LinkedListNode<T>): T

Parameter	Type	Default	Description
`node`	`LinkedListNode<T>`	—	The node to remove

ReturnsTThe value of the removed node

clear

Removes all elements from the list

public clear(): this

ReturnsthisThe list instance for chaining

toArray

Returns a shallow copy of the list values as an array

public toArray(): T[]

ReturnsT[]Array of values from head to tail

toString

Returns a string representation of the list

public toString(): string

ReturnsstringString representation

[Symbol.iterator]

Iterator over list values from head to tail

public* [Symbol.iterator](): Iterator<T>

ReturnsIterator<T, any, any>

[Symbol.asyncIterator]

Async iterator over list values from head to tail

public async* [Symbol.asyncIterator](): AsyncIterator<T>

ReturnsAsyncIterator<T, any, any>