<A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<void>
<A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<void>Updates the value of the Ref atomically using the given function.
When to use
Use to apply a Ref state transition without returning a value.
Example (Updating a value)
import { Effect, Ref } from "effect"
const program = Effect.gen(function*() {
const counter = yield* Ref.make(5)
// Update the value
yield* Ref.update(counter, (n) => n * 2)
const value = yield* Ref.get(counter)
console.log(value) // 10
})
// Using multiple operations
const program2 = Effect.gen(function*() {
const counter = yield* Ref.make(5)
yield* Ref.update(counter, (n: number) => n + 10)
const value = yield* Ref.get(counter)
console.log(value) // 15
})export const const update: (<A>(
f: (a: A) => A
) => (self: Ref<A>) => Effect.Effect<void>) &
(<A>(
self: Ref<A>,
f: (a: A) => A
) => Effect.Effect<void>)
Updates the value of the Ref atomically using the given function.
When to use
Use to apply a Ref state transition without returning a value.
Example (Updating a value)
import { Effect, Ref } from "effect"
const program = Effect.gen(function*() {
const counter = yield* Ref.make(5)
// Update the value
yield* Ref.update(counter, (n) => n * 2)
const value = yield* Ref.get(counter)
console.log(value) // 10
})
// Using multiple operations
const program2 = Effect.gen(function*() {
const counter = yield* Ref.make(5)
yield* Ref.update(counter, (n: number) => n + 10)
const value = yield* Ref.get(counter)
console.log(value) // 15
})
update = import dualdual<
<function (type parameter) A in <A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<void>A>(f: (a: A) => Af: (a: Aa: function (type parameter) A in <A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<void>A) => function (type parameter) A in <A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<void>A) => (self: Ref<A>(parameter) self: {
ref: MutableRef.MutableRef<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; <…;
}
interface Ref<in out A>A mutable reference that provides atomic read, write, and update operations.
When to use
Use to keep shared mutable state that is read and updated inside Effect
programs.
Details
A Ref is a thread-safe mutable reference type for shared state. It supports
simple read and write operations as well as atomic transformations.
Example (Reading and updating a ref)
import { Effect, Ref } from "effect"
const program = Effect.gen(function*() {
// Create a ref with initial value
const counter = yield* Ref.make(0)
// Read the current value
const value = yield* Ref.get(counter)
console.log(value) // 0
// Update the value atomically
yield* Ref.update(counter, (n) => n + 1)
// Read the updated value
const newValue = yield* Ref.get(counter)
console.log(newValue) // 1
})
The Ref namespace containing type definitions and utilities.
When to use
Use when referring to type members nested under the Ref namespace.
Ref<function (type parameter) A in <A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<void>A>) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void>,
<function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<void>A>(self: Ref<A>(parameter) self: {
ref: MutableRef.MutableRef<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; <…;
}
interface Ref<in out A>A mutable reference that provides atomic read, write, and update operations.
When to use
Use to keep shared mutable state that is read and updated inside Effect
programs.
Details
A Ref is a thread-safe mutable reference type for shared state. It supports
simple read and write operations as well as atomic transformations.
Example (Reading and updating a ref)
import { Effect, Ref } from "effect"
const program = Effect.gen(function*() {
// Create a ref with initial value
const counter = yield* Ref.make(0)
// Read the current value
const value = yield* Ref.get(counter)
console.log(value) // 0
// Update the value atomically
yield* Ref.update(counter, (n) => n + 1)
// Read the updated value
const newValue = yield* Ref.get(counter)
console.log(newValue) // 1
})
The Ref namespace containing type definitions and utilities.
When to use
Use when referring to type members nested under the Ref namespace.
Ref<function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<void>A>, f: (a: A) => Af: (a: Aa: function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<void>A) => function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<void>A) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void>
>(2, <function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): anyA>(self: Ref<A>(parameter) self: {
ref: MutableRef.MutableRef<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; <…;
}
interface Ref<in out A>A mutable reference that provides atomic read, write, and update operations.
When to use
Use to keep shared mutable state that is read and updated inside Effect
programs.
Details
A Ref is a thread-safe mutable reference type for shared state. It supports
simple read and write operations as well as atomic transformations.
Example (Reading and updating a ref)
import { Effect, Ref } from "effect"
const program = Effect.gen(function*() {
// Create a ref with initial value
const counter = yield* Ref.make(0)
// Read the current value
const value = yield* Ref.get(counter)
console.log(value) // 0
// Update the value atomically
yield* Ref.update(counter, (n) => n + 1)
// Read the updated value
const newValue = yield* Ref.get(counter)
console.log(newValue) // 1
})
The Ref namespace containing type definitions and utilities.
When to use
Use when referring to type members nested under the Ref namespace.
Ref<function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): anyA>, f: (a: A) => Af: (a: Aa: function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): anyA) => function (type parameter) A in <A>(self: Ref<A>, f: (a: A) => A): anyA) =>
import EffectEffect.sync(() => {
self: Ref<A>(parameter) self: {
ref: MutableRef.MutableRef<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; <…;
}
Ref<in out A>.ref: MutableRef.MutableRef<A>(property) Ref<in out A>.ref: {
current: T;
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;
}
f: (a: A) => Af(self: Ref<A>(parameter) self: {
ref: MutableRef.MutableRef<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; <…;
}
Ref<in out A>.ref: MutableRef.MutableRef<A>(property) Ref<in out A>.ref: {
current: T;
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;
}