(self: TxSemaphore): Effect.Effect<boolean>Tries to acquire a single permit from the semaphore without blocking,
returning true if successful or false if no permits are available.
When to use
Use to attempt a single-permit acquisition without retrying when no permit is available.
Example (Trying to acquire a permit)
import { Console, Effect, TxSemaphore } from "effect"
const program = Effect.gen(function*() {
const semaphore = yield* TxSemaphore.make(1)
// First try should succeed
const first = yield* TxSemaphore.tryAcquire(semaphore)
yield* Console.log(`First try: ${first}`) // true
// Second try should fail (no permits left)
const second = yield* TxSemaphore.tryAcquire(semaphore)
yield* Console.log(`Second try: ${second}`) // false
})export const const tryAcquire: (
self: TxSemaphore
) => Effect.Effect<boolean>
Tries to acquire a single permit from the semaphore without blocking,
returning true if successful or false if no permits are available.
When to use
Use to attempt a single-permit acquisition without retrying when no permit is
available.
Example (Trying to acquire a permit)
import { Console, Effect, TxSemaphore } from "effect"
const program = Effect.gen(function*() {
const semaphore = yield* TxSemaphore.make(1)
// First try should succeed
const first = yield* TxSemaphore.tryAcquire(semaphore)
yield* Console.log(`First try: ${first}`) // true
// Second try should fail (no permits left)
const second = yield* TxSemaphore.tryAcquire(semaphore)
yield* Console.log(`Second try: ${second}`) // false
})
tryAcquire = (self: TxSemaphore(parameter) self: {
permitsRef: TxRef.TxRef<number>;
capacity: number;
toString: () => string;
toJSON: () => unknown;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
import EffectEffect.interface Effect<out A, out E = never, out R = never>The Effect interface defines a value that lazily describes a workflow or
job. The workflow requires some context R, and may fail with an error of
type E, or succeed with a value of type A.
When to use
Use when you need to represent a lazy, composable workflow that can require
services, fail with a typed error, or succeed with a typed value.
Details
Effect values model resourceful interaction with the outside world,
including synchronous, asynchronous, concurrent, and parallel interaction.
They use a fiber-based concurrency model, with built-in support for
scheduling, fine-grained interruption, structured concurrency, and high
scalability.
To run an Effect value, you need a Runtime, which is a type that is
capable of executing Effect values.
Effect<boolean> =>
import TxRefTxRef.const modify: {
<A, R>(
f: (
current: NoInfer<A>
) => [returnValue: R, newValue: A]
): (self: TxRef<A>) => Effect.Effect<R>
<A, R>(
self: TxRef<A>,
f: (
current: A
) => [returnValue: R, newValue: A]
): Effect.Effect<R>
}
self: TxSemaphore(parameter) self: {
permitsRef: TxRef.TxRef<number>;
capacity: number;
toString: () => string;
toJSON: () => unknown;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
TxSemaphore.permitsRef: TxRef.TxRef<number>(property) TxSemaphore.permitsRef: {
version: number;
pending: Map<unknown, () => void>;
value: A;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
permits: numberpermits: number) => {
if (permits: numberpermits > 0) {
return [true, permits: numberpermits - 1]
}
return [false, permits: numberpermits]
})