Generic pooling library
Useful for managing resources like database connections.
$ npm install pewl
Here's a simple example of how to get up and running with pewl.
const Pool = require('pewl');
// create a Pool instance.
const pool = new Pool({
create: () => asyncFuncThatCreatesResource(),
destroy: resource => asyncFuncThatDestroysResource(resource)
});
// open the pool
await pool.open();
// get a resource from the pool
const resource = await pool.acquire();
// return the resource to the pool
pool.release(resource);
// close the pool when finished
await pool.close();
Returns a new pool instance.
Type: Object
Type: number
Default: Infinity
Duration to wait before rejecting acquire request.
Type: string[]
Attributes used to describe the Pool when using a Cluster.
Type: number
Default: Infinity
Concurrency limit for making resource requests.
Type: Function
Function that returns a Promise that resolves with a resource.
Type: Function
Accepts a resource value and attempts to destroy it, returning a promise upon completion.
Type: number
Default: Infinity
Marks a resource as dead after this duration.
Type: boolean
Default: true
Treats the Pool like a stack (as opposed to a queue).
Type: number
Default: 600000
Marks a resource as idle after this duration.
Type: Function
Accepts a Resource object and returns a boolean stating whether or not the resource is dead.
Type: Function
Accepts a Resource object and returns a boolean stating whether or not the resource is idle.
Type: number
Default: Infinity
Maximum number of resources the pool can create.
Type: number
Default: Infinity
Maximum number of idle resources the pool can contain with respect to the min
and max options.
Type: number
Default: 0
Minimum number of resources that must be in the pool at all times.
Type: Function
Accepts a resource value and attempts to ping it, returning a promise upon completion.
Type: number
Default: 600000
Frequency to ping idle resources.
Type: number
Frequency to check for and dispose of dead and idle resources with respect to
the min and max options.
Returns a promise that settles when a resource is acquired.
Type: Object
Type: Number
Default: 0
Priority of operation. Operations with greater priority will be schedule first.
Returns a promise that settles once all resources have been destroyed.
Returns a promise that settles once the suppled resource is destroyed.
Returns a promise that settles once the pool is opened and filled to the min
value.
Releases a resource back into the pool.
Number of available resources.
Number of borrowed resources.
Number of idle resources.
Total number of resources in pool.
Returns a new cluster instance.
Type: Object
Options to be applied to all pool instances within the cluster.
Type: number
Default: Infinity
Duration to wait before rejecting acquire request.
Type: number
Default: Infinity
Concurrency limit for making resource requests.
Type: number
Default: Infinity
Marks a resource as dead after this duration.
Type: boolean
Default: true
Treats the Pool like a stack (as opposed to a queue).
Type: number
Default: 600000
Marks a resource as idle after this duration.
Type: Function
Accepts a resource value and attempts to ping it, returning a promise upon completion.
Type: number
Default: 600000
Frequency to ping idle resources.
Type: Pool[]
List of pool instances.
Type: number
Frequency to check for and dispose of dead and idle resources with respect to
the min and max options.
Returns a promise that settles when a resource is acquired.
Type: Object
Type: string[]
List of attributes that the resource must have.
Type: number
Default: 0
Priority of operation. Operations with greater priority will be schedule first.
Adds a pool instance to the cluster.
Returns a promise that settles once the cluster and all the pool instances
have been closed.
Destroys the provided resource.
Returns a promise that settles once all the pool instances have been opened
and filled.
Releases the resource back into the cluster.
Gets a ClusterStats object for the cluster resources.
Type: String[]
Attributes to apply to the stats.
const Pool = require('pewl');
// create a pool of read-only resources
const readPool = new Pool({
attributes: ['r'],
...
});
// create a pool of read-write resources
const readWritePool = new Pool({
attributes: ['r', 'w'],
...
});
// create a cluster to manage both pools
const cluster = new Pool.Cluster({
pools: [readPool, readWritePool]
});
// start all the things!
await cluster.open();
// acquire the first available resource
const readOnlyResource = await cluster.acquire();
// release the resource back into the cluster
cluster.release(readOnlyResource);
// acquire a write capable resource
const readWriteResource = await cluster.acquire({ attributes: ['w'] });
// destroy the write capable resource
cluster.destroy(readWriteResource);
// close all the things!
await cluster.close();
FAQs
Generic Pooling Library
We found that pewl demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A malicious NuGet package impersonating Sicoob exfiltrated client IDs, PFX passwords, and banking certificates through Sentry telemetry.
Security News
Feross Aboukhadijeh joins TBPN to discuss Socket's $60M Series C, 500%+ ARR growth, AI's impact on open source, and the rise in supply chain attacks.
Security News
OSV withdrew 157 OSV malware reports after automated false positives incorrectly flagged trusted npm and PyPI packages, sending bad records into tools that rely on OSV data.