<V>(self: TxHashSet<V>): Effect.Effect<HashSet.HashSet<V>>Converts the TxHashSet to an immutable HashSet snapshot.
Example (Taking a HashSet snapshot)
import { Effect, HashSet, TxHashSet } from "effect"
const program = Effect.gen(function*() {
const txSet = yield* TxHashSet.make("x", "y", "z")
const hashSet = yield* TxHashSet.toHashSet(txSet)
console.log(HashSet.size(hashSet)) // 3
console.log(HashSet.has(hashSet, "y")) // true
// hashSet is a snapshot - modifications to txSet don't affect it
yield* TxHashSet.add(txSet, "w")
console.log(HashSet.size(hashSet)) // 3 (unchanged)
console.log(yield* TxHashSet.size(txSet)) // 4
})export const const toHashSet: <V>(
self: TxHashSet<V>
) => Effect.Effect<HashSet.HashSet<V>>
Converts the TxHashSet to an immutable HashSet snapshot.
Example (Taking a HashSet snapshot)
import { Effect, HashSet, TxHashSet } from "effect"
const program = Effect.gen(function*() {
const txSet = yield* TxHashSet.make("x", "y", "z")
const hashSet = yield* TxHashSet.toHashSet(txSet)
console.log(HashSet.size(hashSet)) // 3
console.log(HashSet.has(hashSet, "y")) // true
// hashSet is a snapshot - modifications to txSet don't affect it
yield* TxHashSet.add(txSet, "w")
console.log(HashSet.size(hashSet)) // 3 (unchanged)
console.log(yield* TxHashSet.size(txSet)) // 4
})
toHashSet = <function (type parameter) V in <V>(self: TxHashSet<V>): Effect.Effect<HashSet.HashSet<V>>V>(self: TxHashSet<V>(parameter) self: {
ref: TxRef.TxRef<HashSet.HashSet<V>>;
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 TxHashSet<in out V>A TxHashSet is a transactional hash set data structure that provides atomic operations on unique values within Effect transactions. It uses an immutable HashSet internally with TxRef for transactional semantics, ensuring all operations are performed atomically.
Details
Mutation operations such as add, remove, and clear update the original TxHashSet and return Effect<void> or Effect<boolean>. Transform operations such as union, intersection, difference, map, and filter create new TxHashSet instances and leave the original TxHashSet unchanged.
Example (Using transactional hash sets)
import { Effect, TxHashSet } from "effect"
const program = Effect.gen(function*() {
// Create a transactional hash set
const txSet = yield* TxHashSet.make("apple", "banana", "cherry")
// Single operations are automatically transactional
yield* TxHashSet.add(txSet, "grape")
const hasApple = yield* TxHashSet.has(txSet, "apple")
console.log(hasApple) // true
// Multi-step atomic operations
yield* Effect.tx(
Effect.gen(function*() {
const hasCherry = yield* TxHashSet.has(txSet, "cherry")
if (hasCherry) {
yield* TxHashSet.remove(txSet, "cherry")
yield* TxHashSet.add(txSet, "orange")
}
})
)
const size = yield* TxHashSet.size(txSet)
console.log(size) // 4
})
The TxHashSet namespace contains type-level utilities and helper types
for working with TxHashSet instances.
Example (Extracting value types inside transactions)
import { Effect, TxHashSet } from "effect"
const program = Effect.gen(function*() {
// Create a transactional color set
const colors = yield* TxHashSet.make("red", "green", "blue")
// Extract the value type for reuse
type Color = TxHashSet.TxHashSet.Value<typeof colors> // string
// Use extracted type in functions
const addColor = (color: Color) => TxHashSet.add(colors, color)
yield* addColor("yellow")
})
TxHashSet<function (type parameter) V in <V>(self: TxHashSet<V>): Effect.Effect<HashSet.HashSet<V>>V>): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import HashSetHashSet.type HashSet.HashSet = /*unresolved*/ anyHashSet<function (type parameter) V in <V>(self: TxHashSet<V>): Effect.Effect<HashSet.HashSet<V>>V>> => import TxRefTxRef.const get: <A>(
self: TxRef<A>
) => Effect.Effect<A>
Reads the current value of the TxRef.
When to use
Use to read the current value of a TxRef.
Example (Reading transactional references)
import { Effect, TxRef } from "effect"
const program = Effect.gen(function*() {
const counter = yield* TxRef.make(42)
// Read the value within a transaction
const value = yield* Effect.tx(
TxRef.get(counter)
)
console.log(value) // 42
})
get(self: TxHashSet<V>(parameter) self: {
ref: TxRef.TxRef<HashSet.HashSet<V>>;
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; <…;
}
TxHashSet<in out V>.ref: TxRef.TxRef<HashSet.HashSet<V>>(property) TxHashSet<in out V>.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; <…;
}