Class Pool<O>

Object pool.

Type Parameters

O

Index

Constructors

Methods

Constructors

constructor

new Pool<O>(
options: { create: () => O; maxSize?: number; reset?: (o: O) => void },
): Pool<O>
Create a new pool.
Type Parameters
- O
Parameters
- options: { create: () => O; maxSize?: number; reset?: (o: O) => void }
  Pool creation options
  
  create: Function to create a pool entry
  
  reset: Optional function that resets an entry when it is returned to the pool
  
  maxSize: If this size is exceeded, objects returned to the pool will be discarded
Returns Pool<O>
- Defined in util/pool.ts:19

Methods

return

return(o: O): void
Return an object to the pool. If the pool's max size is reached, the object will be discarded.
Parameters
- o: O
  Object to return
Returns void
- Defined in util/pool.ts:41

take

take(): O
Take an object out of the pool. If the pool is empty, an object will be created.

Returns O
Pool object
- Defined in util/pool.ts:33