Class Pool<T, I>`Advanced`

A generic class for managing a pool of items.

Type Parameters

T extends PoolItem
The type of items in the pool. Must implement PoolItem.
I = Parameters<NonNullable<T["init"]>>[0]
The type of argument passed to item's init method if it exists.

Index

Constructors

Accessors

totalFree totalSize totalUsed

Methods

clear get prepopulate return

Constructors

constructor

new Pool<T extends PoolItem, I = Parameters<NonNullable<T["init"]>>[0]>(
ClassType: PoolItemConstructor<T>,
initialSize?: number,
): Pool<T, I>
Constructs a new Pool.
Type Parameters
- T extends PoolItem
  The type of items in the pool. Must implement PoolItem.
- I = Parameters<NonNullable<T["init"]>>[0]
  The type of argument passed to item's init method if it exists.
Parameters
- ClassType: PoolItemConstructor<T>
  The constructor of the items in the pool.
- OptionalinitialSize: number
  The initial size of the pool.
Returns Pool<T, I>

Accessors

totalFree

get totalFree(): number
Gets the number of items in the pool that are free to use without needing to create more.

Returns number

totalSize

get totalSize(): number
Gets the number of items in the pool.

Returns number

totalUsed

get totalUsed(): number
Gets the number of items in the pool that are currently in use.

Returns number

Methods

clear

clear(): void
clears the pool

Returns void

get

get(data?: I): T
Gets an item from the pool. Calls the item's init method if it exists. If there are no items left in the pool, a new one will be created.
Parameters
- Optionaldata: I
  Optional data to pass to the item's constructor.
Returns T
The item from the pool.

prepopulate

prepopulate(total: number): void
Prepopulates the pool with a given number of items.
Parameters
- total: number
  The number of items to add to the pool.
Returns void

return

return(item: T): void
Returns an item to the pool. Calls the item's reset method if it exists.
Parameters
- item: T
  The item to return to the pool.
Returns void