100 lines
3.4 KiB
JavaScript
100 lines
3.4 KiB
JavaScript
import * as internal from "./internal/pool.js";
|
|
/**
|
|
* @since 2.0.0
|
|
* @category symbols
|
|
*/
|
|
export const PoolTypeId = internal.PoolTypeId;
|
|
/**
|
|
* Returns `true` if the specified value is a `Pool`, `false` otherwise.
|
|
*
|
|
* @since 2.0.0
|
|
* @category refinements
|
|
*/
|
|
export const isPool = internal.isPool;
|
|
/**
|
|
* Makes a new pool of the specified fixed size. The pool is returned in a
|
|
* `Scope`, which governs the lifetime of the pool. When the pool is shutdown
|
|
* because the `Scope` is closed, the individual items allocated by the pool
|
|
* will be released in some unspecified order.
|
|
*
|
|
* By setting the `concurrency` parameter, you can control the level of concurrent
|
|
* access per pool item. By default, the number of permits is set to `1`.
|
|
*
|
|
* `targetUtilization` determines when to create new pool items. It is a value
|
|
* between 0 and 1, where 1 means only create new pool items when all the existing
|
|
* items are fully utilized.
|
|
*
|
|
* A `targetUtilization` of 0.5 will create new pool items when the existing items are
|
|
* 50% utilized.
|
|
*
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export const make = internal.make;
|
|
/**
|
|
* Makes a new pool with the specified minimum and maximum sizes and time to
|
|
* live before a pool whose excess items are not being used will be shrunk
|
|
* down to the minimum size. The pool is returned in a `Scope`, which governs
|
|
* the lifetime of the pool. When the pool is shutdown because the `Scope` is
|
|
* used, the individual items allocated by the pool will be released in some
|
|
* unspecified order.
|
|
*
|
|
* By setting the `concurrency` parameter, you can control the level of concurrent
|
|
* access per pool item. By default, the number of permits is set to `1`.
|
|
*
|
|
* `targetUtilization` determines when to create new pool items. It is a value
|
|
* between 0 and 1, where 1 means only create new pool items when all the existing
|
|
* items are fully utilized.
|
|
*
|
|
* A `targetUtilization` of 0.5 will create new pool items when the existing items are
|
|
* 50% utilized.
|
|
*
|
|
* The `timeToLiveStrategy` determines how items are invalidated. If set to
|
|
* "creation", then items are invalidated based on their creation time. If set
|
|
* to "usage", then items are invalidated based on pool usage.
|
|
*
|
|
* By default, the `timeToLiveStrategy` is set to "usage".
|
|
*
|
|
* ```ts skip-type-checking
|
|
* import { createConnection } from "mysql2";
|
|
* import { Duration, Effect, Pool } from "effect"
|
|
*
|
|
* const acquireDBConnection = Effect.acquireRelease(
|
|
* Effect.sync(() => createConnection('mysql://...')),
|
|
* (connection) => Effect.sync(() => connection.end(() => {})),
|
|
* )
|
|
*
|
|
* const connectionPool = Effect.flatMap(
|
|
* Pool.makeWithTTL({
|
|
* acquire: acquireDBConnection,
|
|
* min: 10,
|
|
* max: 20,
|
|
* timeToLive: Duration.seconds(60)
|
|
* }),
|
|
* (pool) => pool.get
|
|
* )
|
|
* ```
|
|
*
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export const makeWithTTL = internal.makeWithTTL;
|
|
/**
|
|
* Retrieves an item from the pool in a scoped effect. Note that if
|
|
* acquisition fails, then the returned effect will fail for that same reason.
|
|
* Retrying a failed acquisition attempt will repeat the acquisition attempt.
|
|
*
|
|
* @since 2.0.0
|
|
* @category getters
|
|
*/
|
|
export const get = internal.get;
|
|
/**
|
|
* Invalidates the specified item. This will cause the pool to eventually
|
|
* reallocate the item, although this reallocation may occur lazily rather
|
|
* than eagerly.
|
|
*
|
|
* @since 2.0.0
|
|
* @category combinators
|
|
*/
|
|
export const invalidate = internal.invalidate;
|
|
//# sourceMappingURL=Pool.js.map
|