Installation
Using Bun
bash
bun add poolsUsing npm
bash
npm install poolsUsing pnpm
bash
pnpm add poolsUsing yarn
bash
yarn add poolsTypeScript
The library is written in TypeScript and includes full type definitions. No additional @types packages needed.
Ensure you have TypeScript configured with strict mode:
json
{
"compilerOptions": {
"strict": true,
"noUncheckedIndexedAccess": true
}
}Importing
typescript
// Import main classes
import { Pool, Binder, Selectors } from 'pools';
// Import types
import type { PoolEntry, Filter, Selector } from 'pools';Requirements
- TypeScript 5.0+
- Modern JavaScript runtime (Bun, Node.js 18+, Deno)
Next Steps
- Quick Start - Get started in 5 minutes
- API Reference - Complete API documentation