effect-io-ai

Package: effect
Module: TxReentrantLock

TxReentrantLock.releaseRead

Releases one read lock held by the current fiber.

When to use

Use to leave a manually acquired read lock.

Details

Returns the remaining number of read locks held by this fiber.

Example (Releasing a read lock)

import { Effect, TxReentrantLock } from "effect"

const program = Effect.gen(function*() {
  const lock = yield* TxReentrantLock.make()
  yield* TxReentrantLock.acquireRead(lock)
  const remaining = yield* TxReentrantLock.releaseRead(lock)
  console.log(remaining) // 0
})

Signature

declare const releaseRead: (self: TxReentrantLock) => Effect.Effect<number>

Source

Since v2.0.0