helpers.lists.LimitedList - ZeMA-gGmbH/NoPE-JS GitHub Wiki

Class: LimitedList<T>

helpers.lists.LimitedList

Limited List. This list at max contains a specific amount of elements. After the max number of elements has been added, the first element added will be removed.

Type parameters

Name
T

Constructors

constructor

new LimitedList<T>(maxLength)

Type parameters

Name
T

Parameters

Name Type
maxLength number

Properties

maxLength

maxLength: number

Accessors

currentPointer

get currentPointer(): number

Gets the current pointer.

Memberof

LimitedList

Returns

number


length

get length(): number

Contains the Length of the list.

Memberof

LimitedList

Returns

number

Methods

current

current(): T

Returns the current item, the pointer is showing at.

Returns

T


first

first(): T

Returns the Pointer to the first item.

Returns

T


forEach

forEach(callbackFn, thisArg?): void

Helper to iterate over all items.

Parameters

Name Type
callbackFn (item: T, index: number, array: T[]) => void
thisArg? any

Returns

void


last

last(): T

Returns

T


next

next(): T

Returns

T


pop

pop(current?): T

Pops the last element. If there is no element undefined is returned.

Parameters

Name Type Default value
current boolean false

Returns

T

The last element.


previous

previous(): T

Returns the last item. Adapts the pointer and the current item is the last item. example: l = limited.last() c = limited.current()

 l == c -> True

Returns

T

The last element.


push

push(data): number

Adds Data to the Stack. The Pointer is getting adapted.

Memberof

LimitedList

Parameters

Name Type
data T

Returns

number

⚠️ **GitHub.com Fallback** ⚠️