@philiprehberger/disposable-pool

Generic async resource pool with acquire/release, validation, and auto-scaling.

Installation

npm install @philiprehberger/disposable-pool

Usage

import { createPool } from '@philiprehberger/disposable-pool';

const pool = createPool({
  create: async () => await connectToDatabase(),
  destroy: async (conn) => await conn.close(),
  validate: async (conn) => conn.isAlive(),
  min: 2,
  max: 10,
  idleTimeout: 30000,
  acquireTimeout: 5000,
});

// Auto-release with withResource
const result = await pool.withResource(async (conn) => {
  return await conn.query('SELECT * FROM users');
});

// Manual acquire/release
const conn = await pool.acquire();
try {
  await conn.query('INSERT INTO logs ...');
} finally {
  pool.release(conn);
}

// Flush stale idle resources without touching active ones
await pool.clear();

// Graceful shutdown
await pool.drain();

API

createPool<T>(options: PoolOptions<T>): Pool<T>

Creates a new resource pool.

PoolOptions<T>

• create — Factory function returning a new resource
• destroy — Cleanup function for a resource
• validate? — Check if a resource is still valid before reuse
• min? — Minimum resources to pre-warm and keep alive (default: 0)
• max? — Maximum pool size (default: Infinity)
• idleTimeout? — Destroy idle resources after this many ms (never below min)
• acquireTimeout? — Reject acquire if waiting longer than this many ms

Pool<T>

• acquire() — Get a resource from the pool
• release(resource) — Return a resource to the pool
• withResource(fn) — Acquire, run fn, auto-release
• clear() — Destroy all idle resources and re-warm up to min
• drain() — Destroy all resources and reject pending waiters
• size — Total resources (idle + active)
• available — Number of idle resources
• pending — Number of queued waiters

Development

npm install
npm run build
npm test

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT