Class ObjectPool<T>

A generic object pool for recycling objects to reduce pressure on the garbage collector.

Type Parameters

T

Index

Constructors

Accessors

available capacity inUse

Methods

[iterator] forEach getStats pop prewarm push reset

Constructors

constructor

new ObjectPool<T>(config: ObjectPoolConfig<T>): ObjectPool<T>
Type Parameters
- T
Parameters
- config: ObjectPoolConfig<T>
Returns ObjectPool<T>

Accessors

available

get available(): number
The number of objects currently available in the pool.

Returns number

capacity

get capacity(): number
The total number of objects managed by this pool (both available and in use).

Returns number

inUse

get inUse(): number
The number of objects that are currently "checked out" of the pool.

Returns number

Methods

[iterator]

"[iterator]"(): Iterator<T>
Allows the pool to be used in for...of loops, iterating over available items.

Returns Iterator<T>

forEach

forEach(callback: (item: T, index: number, array: T[]) => void): void
Executes a callback for each available item in the pool.
Parameters
- callback: (item: T, index: number, array: T[]) => void
  The function to execute for each item.
Returns void

getStats

getStats(): PoolStats
Returns an object with the current pool statistics.

Returns PoolStats
An object containing capacity, available, inUse, and utilizationRate.

pop

pop(): T
Retrieves an object from the pool. If the pool is empty, it will automatically grow to create new objects.

Returns T
An object of type T.

prewarm

prewarm(amount: number): void
Explicitly adds a specified number of new objects to the pool.
Parameters
- amount: number
  The number of new objects to create.
Returns void

push

push(item: T): void
Returns an object to the pool, making it available for reuse.
Parameters
- item: T
  The object to return to the pool.
Returns void

reset

reset(): void
Forcibly returns all borrowed items to the pool.

This is a powerful tool for preventing memory leaks. By calling this at the beginning of a frame or a top-level operation, you ensure that any objects that were not explicitly released are reclaimed.

Returns void