Class Linked<T>

Doubly Linked List

Type parameters

T

Hierarchy

Linked

Implements

Iterable<T>

Index

Methods

Constructors

constructor

Properties

Accessors

Methods

Static from

from<T>(iter: Iterable<T>): Linked<T>

- Defined in linked.ts:8
Create linked list from iterator

Type parameters
- T
Parameters
- iter: Iterable<T>
Returns Linked<T>

Static of

of<T>(...items: T[]): Linked<T>

- Defined in linked.ts:16
Create linked list from params

Type parameters
- T
Parameters
- Rest ...items: T[]
Returns Linked<T>

[iterator]

[iterator](): Iterator<T, any, undefined>

Implementation of Iterable.__@iterator@93
- Defined in linked.ts:47
Get an iterator to traverse the list items

Returns Iterator<T, any, undefined>

items

items(): IterableIterator<T>

- Defined in linked.ts:52
Get an iterator to traverse the list items

Returns IterableIterator<T>

backItems

backItems(): IterableIterator<T>

- Defined in linked.ts:59
Get an iterator that traverses the list items in reverse

Returns IterableIterator<T>

nodes

nodes(): IterableIterator<LinkedNode<T>>

- Defined in linked.ts:66
Get an iterator to traverse the list nodes

Returns IterableIterator<LinkedNode<T>>

backNodes

backNodes(): IterableIterator<LinkedNode<T>>

- Defined in linked.ts:73
Get an iterator that traverses the list nodes in reverse

Returns IterableIterator<LinkedNode<T>>

clear

clear(): void

- Defined in linked.ts:80
Clear list items

Returns void

push

push(val: T): LinkedNode<T>
push(...vals: T[]): void

- Defined in linked.ts:85
Add an item to the end of the linked list

Parameters
- val: T
Returns LinkedNode<T>
- Defined in linked.ts:87
Add many items to the end of the linked list

Parameters
- Rest ...vals: T[]
Returns void

pushNode

pushNode(...nodes: LinkedNode<T>[]): void

- Defined in linked.ts:94
Add many nodes to the end of the linked list unsafe method, will not verify the node

Parameters
- Rest ...nodes: LinkedNode<T>[]
Returns void

unshift

unshift(val: T): void
unshift(...vals: T[]): void

- Defined in linked.ts:111
Add an item to the head of the linked list

Parameters
- val: T
Returns void
- Defined in linked.ts:113
Add many items to the head of the linked list

Parameters
- Rest ...vals: T[]
Returns void

unshiftNode

unshiftNode(...nodes: LinkedNode<T>[]): void

- Defined in linked.ts:120
Add many nodes to the head of the linked list unsafe method, will not verify the node

Parameters
- Rest ...nodes: LinkedNode<T>[]
Returns void

pop

pop(): undefined | T

- Defined in linked.ts:144
Remove an item from the end of the list

Returns undefined | T

popNode

popNode(): undefined | LinkedNode<T>

- Defined in linked.ts:148
Remove a node from the end of the linked list

Returns undefined | LinkedNode<T>

shift

shift(): undefined | T

- Defined in linked.ts:161
Remove an item from the head of the list

Returns undefined | T

shiftNode

shiftNode(): undefined | LinkedNode<T>

- Defined in linked.ts:165
Remove a node from the head of the list

Returns undefined | LinkedNode<T>

addAfter

addAfter(target: LinkedNode<T>, val: T): void

- Defined in linked.ts:179
After adding an item to a node unsafe method, will not verify the node

Parameters
- target: LinkedNode<T>
- val: T
Returns void

addAfterNode

addAfterNode(target: LinkedNode<T>, node: LinkedNode<T>): void

- Defined in linked.ts:185
After adding a node to a node unsafe method, will not verify the node

Parameters
- target: LinkedNode<T>
- node: LinkedNode<T>
Returns void

addBefore

addBefore(target: LinkedNode<T>, val: T): void

- Defined in linked.ts:195
Before adding an item to a node unsafe method, will not verify the node

Parameters
- target: LinkedNode<T>
- val: T
Returns void

addBeforeNode

addBeforeNode(target: LinkedNode<T>, node: LinkedNode<T>): void

- Defined in linked.ts:201
Before adding a node to a node unsafe method, will not verify the node

Parameters
- target: LinkedNode<T>
- node: LinkedNode<T>
Returns void

remove

remove(target: LinkedNode<T>): undefined | LinkedNode<T>

- Defined in linked.ts:211
Remove a node from the linked list unsafe method, will not verify the node

Parameters
- target: LinkedNode<T>
Returns undefined | LinkedNode<T>

Constructors

constructor

new Linked<T>(): Linked<T>

Type parameters
- T
Returns Linked<T>

Properties

Optional head

head?: LinkedNode<T>

The first node of the linked list unsafe field

Optional last

last?: LinkedNode<T>

The last node of the linked list unsafe field

Accessors

isEmpty

get isEmpty(): boolean

- Defined in linked.ts:28
Check if the linked list is empty

Returns boolean

onlyOne

get onlyOne(): boolean

- Defined in linked.ts:33
Check if there is only one item in the linked list

Returns boolean

size

get size(): number

- Defined in linked.ts:38
Get the length of the linked list

Returns number

length

get length(): number

- Defined in linked.ts:42
Get the length of the linked list

Returns number

Generated using TypeDoc