nano-pool

A tiny TypeScript object pool

Allows you to pre-instantiate objects and then request them from a pool

:sparkles: Features

- Tiny bundle size
- Written in TypeScript
- Zero dependencies
- Adheres to the Unity game engine's naming conventions

---

:wrench: Example usage

``ts
import { createObjectPool } from 'nano-pool'

const poolSize = 10

const createObject = () => {
const sprite = new Sprite()
sprite.scale.set(4)
return sprite
}

const objectPool = createObjectPool(poolSize, createObject)

const object1 = objectPool.get()
objectPool.release(object1)
objectPool.releaseAll()
`

---

:package: Install

`console
npm install nano-pool
`

---

:newspaper: API

`ts
createObjectPool(size: number, createObject: (index: number) => T, options?: Options): ObjectPool
`

`ts
type ObjectPool = {
get: () => T
release: (object: T) => void
releaseAll: () => void
countAll: () => number
}
`

`ts
type Options = {
/* Improves debug output /
id?: string
/** Called when object is released back into the pool
*
* Note: This is also called when the object is created, so that any reset logic can be shared
*/
onRelease?: (object: T) => void
}
`

$3

The amount of objects to create

$3

The function that will be used to create new objects

---

$3

#### There are no more objects in the pool when take is called

In development: an error will be thrown.

In production: a new object is created and added to the pool.

#### An object already in the pool is released

In development: an error will be thrown.

In production`: no-op.