<A, E>(result: Result<A, E>): (
self: TxDeferred<A, E>
) => Effect.Effect<boolean>
<A, E>(
self: TxDeferred<A, E>,
result: Result<A, E>
): Effect.Effect<boolean>Completes the deferred with a Result. Returns true if this was the first
completion, false if already completed.
When to use
Use to complete a TxDeferred with an already computed Result.
Example (Completing with a result)
import { Effect, Result, TxDeferred } from "effect"
const program = Effect.gen(function*() {
const deferred = yield* TxDeferred.make<number, string>()
const first = yield* TxDeferred.done(deferred, Result.succeed(42))
console.log(first) // true
const second = yield* TxDeferred.done(deferred, Result.succeed(99))
console.log(second) // false
})mutations
Source effect/TxDeferred.ts:21713 lines
export const const done: {
<A, E>(result: Result<A, E>): (
self: TxDeferred<A, E>
) => Effect.Effect<boolean>
<A, E>(
self: TxDeferred<A, E>,
result: Result<A, E>
): Effect.Effect<boolean>
}
Completes the deferred with a Result. Returns true if this was the first
completion, false if already completed.
When to use
Use to complete a TxDeferred with an already computed Result.
Example (Completing with a result)
import { Effect, Result, TxDeferred } from "effect"
const program = Effect.gen(function*() {
const deferred = yield* TxDeferred.make<number, string>()
const first = yield* TxDeferred.done(deferred, Result.succeed(42))
console.log(first) // true
const second = yield* TxDeferred.done(deferred, Result.succeed(99))
console.log(second) // false
})
done: {
<function (type parameter) A in <A, E>(result: Result<A, E>): (self: TxDeferred<A, E>) => Effect.Effect<boolean>A, function (type parameter) E in <A, E>(result: Result<A, E>): (self: TxDeferred<A, E>) => Effect.Effect<boolean>E>(result: Result<A, E>result: import ResultResult<function (type parameter) A in <A, E>(result: Result<A, E>): (self: TxDeferred<A, E>) => Effect.Effect<boolean>A, function (type parameter) E in <A, E>(result: Result<A, E>): (self: TxDeferred<A, E>) => Effect.Effect<boolean>E>): (self: TxDeferred<A, E>(parameter) self: {
ref: TxRef.TxRef<Option<Result<A, E>>>;
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; <…;
}
interface TxDeferred<in out A, in out E = never>A transactional deferred is a write-once cell readable within transactions.
Readers block (retry the transaction) until a value is committed, and writers
succeed only on the first call; subsequent writes return false.
When to use
Use to coordinate transaction-local readers and one-time completion with a
success or failure result.
Example (Completing a transactional deferred)
import { Effect, TxDeferred } from "effect"
const program = Effect.gen(function*() {
const deferred = yield* TxDeferred.make<number>()
// Complete the deferred
const first = yield* TxDeferred.succeed(deferred, 42)
console.log(first) // true
// Second write is a no-op
const second = yield* TxDeferred.succeed(deferred, 99)
console.log(second) // false
// Read the value
const value = yield* TxDeferred.await(deferred)
console.log(value) // 42
})
TxDeferred<function (type parameter) A in <A, E>(result: Result<A, E>): (self: TxDeferred<A, E>) => Effect.Effect<boolean>A, function (type parameter) E in <A, E>(result: Result<A, E>): (self: TxDeferred<A, E>) => Effect.Effect<boolean>E>) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<boolean>
<function (type parameter) A in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>A, function (type parameter) E in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>E>(self: TxDeferred<A, E>(parameter) self: {
ref: TxRef.TxRef<Option<Result<A, E>>>;
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; <…;
}
interface TxDeferred<in out A, in out E = never>A transactional deferred is a write-once cell readable within transactions.
Readers block (retry the transaction) until a value is committed, and writers
succeed only on the first call; subsequent writes return false.
When to use
Use to coordinate transaction-local readers and one-time completion with a
success or failure result.
Example (Completing a transactional deferred)
import { Effect, TxDeferred } from "effect"
const program = Effect.gen(function*() {
const deferred = yield* TxDeferred.make<number>()
// Complete the deferred
const first = yield* TxDeferred.succeed(deferred, 42)
console.log(first) // true
// Second write is a no-op
const second = yield* TxDeferred.succeed(deferred, 99)
console.log(second) // false
// Read the value
const value = yield* TxDeferred.await(deferred)
console.log(value) // 42
})
TxDeferred<function (type parameter) A in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>A, function (type parameter) E in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>E>, result: Result<A, E>result: import ResultResult<function (type parameter) A in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>A, function (type parameter) E in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>E>): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<boolean>
} = import dualdual(
2,
<function (type parameter) A in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>A, function (type parameter) E in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>E>(self: TxDeferred<A, E>(parameter) self: {
ref: TxRef.TxRef<Option<Result<A, E>>>;
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; <…;
}
interface TxDeferred<in out A, in out E = never>A transactional deferred is a write-once cell readable within transactions.
Readers block (retry the transaction) until a value is committed, and writers
succeed only on the first call; subsequent writes return false.
When to use
Use to coordinate transaction-local readers and one-time completion with a
success or failure result.
Example (Completing a transactional deferred)
import { Effect, TxDeferred } from "effect"
const program = Effect.gen(function*() {
const deferred = yield* TxDeferred.make<number>()
// Complete the deferred
const first = yield* TxDeferred.succeed(deferred, 42)
console.log(first) // true
// Second write is a no-op
const second = yield* TxDeferred.succeed(deferred, 99)
console.log(second) // false
// Read the value
const value = yield* TxDeferred.await(deferred)
console.log(value) // 42
})
TxDeferred<function (type parameter) A in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>A, function (type parameter) E in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>E>, result: Result<A, E>result: import ResultResult<function (type parameter) A in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>A, function (type parameter) E in <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>E>): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<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: TxDeferred<A, E>(parameter) self: {
ref: TxRef.TxRef<Option<Result<A, E>>>;
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; <…;
}
TxDeferred<in out A, in out E = never>.ref: TxRef.TxRef<Option<Result<A, E>>>(property) TxDeferred<in out A, in out E = never>.ref: {
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; <…;
}
current: Option<Result<A, E>>current) => {
if (import OO.isSome(current: Option<Result<A, E>>current)) {
return [false, current: O.Some<Result<A, E>>(parameter) current: {
_tag: "Some";
_op: "Some";
value: A;
valueOrUndefined: 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; <…;
toString: () => string;
toJSON: () => unknown;
}
import OO.some(result: Result<A, E>result)]
})
)Referenced by 2 symbols