Skip to main content Link Search Menu Expand Document (external link)
io

Pool overview

Added in v1.0.0

Table of contents

combinators

invalidate

Invalidates the specified item. This will cause the pool to eventually reallocate the item, although this reallocation may occur lazily rather than eagerly.

Signature

export declare const invalidate: {
  <A>(value: A): <E>(self: Pool<E, A>) => Effect.Effect<Scope.Scope, never, void>
  <E, A>(self: Pool<E, A>, value: A): Effect.Effect<Scope.Scope, never, void>
}

Added in v1.0.0

constructors

make

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.

Signature

export declare const make: <R, E, A>(options: {
  readonly acquire: Effect.Effect<R, E, A>
  readonly size: number
}) => Effect.Effect<Scope.Scope | R, never, Pool<E, A>>

Added in v1.0.0

makeWithTTL

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.

import * as Duration from '@effect/data/Duration'
import * as Effect from '@effect/io/Effect'
import * as Pool from '@effect/io/Pool'
import * as Scope from '@effect/io/Scope'
import { pipe } from '@effect/data/Function'

Effect.scoped(
  pipe(
    Pool.make(acquireDbConnection, 10, 20, Duration.seconds(60)),
    Effect.flatMap((pool) =>
      Effect.scoped(
        pipe(
          pool.get(),
          Effect.flatMap((connection) => useConnection(connection))
        )
      )
    )
  )
)

Signature

export declare const makeWithTTL: <R, E, A>(options: {
  readonly acquire: Effect.Effect<R, E, A>
  readonly min: number
  readonly max: number
  readonly timeToLive: Duration.DurationInput
}) => Effect.Effect<Scope.Scope | R, never, Pool<E, A>>

Added in v1.0.0

getters

get

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.

Signature

export declare const get: <E, A>(self: Pool<E, A>) => Effect.Effect<Scope.Scope, E, A>

Added in v1.0.0

models

Pool (interface)

A Pool<E, A> is a pool of items of type A, each of which may be associated with the acquisition and release of resources. An attempt to get an item A from a pool may fail with an error of type E.

Signature

export interface Pool<E, A> extends Data.Case, Pool.Variance<E, A>, Pipeable {
  /**
   * 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.
   */
  get(): Effect.Effect<Scope.Scope, E, A>

  /**
   * Invalidates the specified item. This will cause the pool to eventually
   * reallocate the item, although this reallocation may occur lazily rather
   * than eagerly.
   */
  invalidate(item: A): Effect.Effect<never, never, void>
}

Added in v1.0.0

refinements

isPool

Returns true if the specified value is a Pool, false otherwise.

Signature

export declare const isPool: (u: unknown) => u is Pool<unknown, unknown>

Added in v1.0.0

symbols

PoolTypeId

Signature

export declare const PoolTypeId: typeof PoolTypeId

Added in v1.0.0

PoolTypeId (type alias)

Signature

export type PoolTypeId = typeof PoolTypeId

Added in v1.0.0

utils

Pool (namespace)

Added in v1.0.0

Variance (interface)

Signature

export interface Variance<E, A> {
  readonly [PoolTypeId]: {
    readonly _E: (_: never) => E
    readonly _A: (_: never) => A
  }
}

Added in v1.0.0