Class RecycableArray<T>

Wraps a regular Javascript Array and offers very limited functionality geared solely towards avoiding garbage colletion.

Author

Jirka Dell'Oro-Friedl, HFU, 2021

Link

https://github.com/JirkaDellOro/FUDGE/wiki/Recycler

Type Parameters

T

Index

Constructors

Accessors

Methods

[iterator] getSorted pop push recycle reset

Constructors

constructor

new RecycableArray<T>(): RecycableArray<T>
Type Parameters
- T
Returns RecycableArray<T>

Accessors

length

get length(): number
Returns number
- Defined in Core/Source/Recycle/RecycableArray.ts:17

Methods

[iterator]

[iterator](): IterableIterator<T>
Recycles the object following the last in the array and increases the array length It must be assured, that none of the objects in the array is still in any use of any kind!

Returns IterableIterator<T>
- Defined in Core/Source/Recycle/RecycableArray.ts:65

getSorted

getSorted(_sort): T[]
Returns a copy of the array sorted according to the given compare function
Parameters
- _sort: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: T
      b: T
      Returns number
Returns T[]
- Defined in Core/Source/Recycle/RecycableArray.ts:73

pop

pop(): T
Removes the last entry from the array and returns it.

Returns T
- Defined in Core/Source/Recycle/RecycableArray.ts:47

push

push(_entry): number
Appends a new entry to the end of the array, and returns the new length of the array.
Parameters
- _entry: T
Returns number
- Defined in Core/Source/Recycle/RecycableArray.ts:38

recycle

recycle(): void
Recycle this array

Returns void
- Defined in Core/Source/Recycle/RecycableArray.ts:31

reset

reset(): void
Sets the virtual length of the array to zero but keeps the entries beyond.

Returns void
- Defined in Core/Source/Recycle/RecycableArray.ts:24