Skip to content
Effect Days 2026 Get your ticket

SynchronizedRef

28 exports Added in v2.0.0 Source

Constructors

make

Added in v2.0.0 Source

Signature

declare const make: <A>(value: A) => Effect.Effect<SynchronizedRef<A>>

Getters

get

Added in v2.0.0 Source

Signature

declare const get: <A>(self: SynchronizedRef<A>) => Effect.Effect<A>

Models

SynchronizedRef interface

Added in v2.0.0 Source

Signature

interface SynchronizedRef<in out A> extends Variance<A>, Ref<A> {
readonly [ignoreSymbol]?: SynchronizedRefUnifyIgnore;
readonly [typeSymbol]?: unknown;
readonly [unifySymbol]?: SynchronizedRefUnify<SynchronizedRef<A>>;
modifyEffect<B, E, R>(f: (a: A) => Effect<readonly [B, A], E, R>): Effect<B, E, R>;
}

SynchronizedRefUnify interface

Added in v3.8.0 Source

Signature

interface SynchronizedRefUnify<A extends {
[typeSymbol]?: any;
}> extends RefUnify<A> {
SynchronizedRef?: () => Extract<A[typeof typeSymbol], SynchronizedRef<any>>;
}

SynchronizedRefUnifyIgnore interface

Added in v3.8.0 Source

Signature

interface SynchronizedRefUnifyIgnore extends RefUnifyIgnore {
Ref?: true;
}

Other

Symbols

Signature

declare const SynchronizedRefTypeId: unique symbol

Signature

type SynchronizedRefTypeId = typeof SynchronizedRefTypeId

Unsafe

unsafeMake

Added in v2.0.0 Source

Signature

declare const unsafeMake: <A>(value: A) => SynchronizedRef<A>

Utils

getAndSet

Added in v2.0.0 Source

Signature

declare const getAndSet: {
<A>(value: A): (self: Ref<A>) => Effect<A>;
<A>(self: Ref<A>, value: A): Effect<A>;
}

getAndUpdate

Added in v2.0.0 Source

Signature

declare const getAndUpdate: {
<A>(f: (a: A) => A): (self: Ref<A>) => Effect<A>;
<A>(self: Ref<A>, f: (a: A) => A): Effect<A>;
}

Signature

declare const getAndUpdateEffect: {
<A, R, E>(f: (a: A) => Effect<A, E, R>): (self: SynchronizedRef<A>) => Effect<A, E, R>;
<A, R, E>(self: SynchronizedRef<A>, f: (a: A) => Effect<A, E, R>): Effect<A, E, R>;
}

Signature

declare const getAndUpdateSome: {
<A>(pf: (a: A) => Option<A>): (self: Ref<A>) => Effect<A>;
<A>(self: Ref<A>, pf: (a: A) => Option<A>): Effect<A>;
}

Signature

declare const getAndUpdateSomeEffect: {
<A, R, E>(pf: (a: A) => Option<Effect<A, E, R>>): (self: SynchronizedRef<A>) => Effect<A, E, R>;
<A, R, E>(self: SynchronizedRef<A>, pf: (a: A) => Option<Effect<A, E, R>>): Effect<A, E, R>;
}

modify

Added in v2.0.0 Source

Signature

declare const modify: {
<A, B>(f: (a: A) => readonly [B, A]): (self: SynchronizedRef<A>) => Effect<B>;
<A, B>(self: SynchronizedRef<A>, f: (a: A) => readonly [B, A]): Effect<B>;
}

modifyEffect

Added in v2.0.0 Source

Signature

declare const modifyEffect: {
<A, B, E, R>(f: (a: A) => Effect<readonly [B, A], E, R>): (self: SynchronizedRef<A>) => Effect<B, E, R>;
<A, B, E, R>(self: SynchronizedRef<A>, f: (a: A) => Effect<readonly [B, A], E, R>): Effect<B, E, R>;
}

modifySome

Added in v2.0.0 Source

Signature

declare const modifySome: {
<B, A>(fallback: B, pf: (a: A) => Option<readonly [B, A]>): (self: Ref<A>) => Effect<B>;
<A, B>(self: Ref<A>, fallback: B, pf: (a: A) => Option<readonly [B, A]>): Effect<B>;
}

Signature

declare const modifySomeEffect: {
<A, B, R, E>(fallback: B, pf: (a: A) => Option<Effect<readonly [B, A], E, R>>): (self: SynchronizedRef<A>) => Effect<B, E, R>;
<A, B, R, E>(self: SynchronizedRef<A>, fallback: B, pf: (a: A) => Option<Effect<readonly [B, A], E, R>>): Effect<B, E, R>;
}

set

Added in v2.0.0 Source

Signature

declare const set: {
<A>(value: A): (self: Ref<A>) => Effect<void>;
<A>(self: Ref<A>, value: A): Effect<void>;
}

setAndGet

Added in v2.0.0 Source

Signature

declare const setAndGet: {
<A>(value: A): (self: Ref<A>) => Effect<A>;
<A>(self: Ref<A>, value: A): Effect<A>;
}

update

Added in v2.0.0 Source

Signature

declare const update: {
<A>(f: (a: A) => A): (self: Ref<A>) => Effect<void>;
<A>(self: Ref<A>, f: (a: A) => A): Effect<void>;
}

updateAndGet

Added in v2.0.0 Source

Signature

declare const updateAndGet: {
<A>(f: (a: A) => A): (self: Ref<A>) => Effect<A>;
<A>(self: Ref<A>, f: (a: A) => A): Effect<A>;
}

Signature

declare const updateAndGetEffect: {
<A, R, E>(f: (a: A) => Effect<A, E, R>): (self: SynchronizedRef<A>) => Effect<A, E, R>;
<A, R, E>(self: SynchronizedRef<A>, f: (a: A) => Effect<A, E, R>): Effect<A, E, R>;
}

updateEffect

Added in v2.0.0 Source

Signature

declare const updateEffect: {
<A, R, E>(f: (a: A) => Effect<A, E, R>): (self: SynchronizedRef<A>) => Effect<void, E, R>;
<A, R, E>(self: SynchronizedRef<A>, f: (a: A) => Effect<A, E, R>): Effect<void, E, R>;
}

updateSome

Added in v2.0.0 Source

Signature

declare const updateSome: {
<A>(f: (a: A) => Option<A>): (self: Ref<A>) => Effect<void>;
<A>(self: Ref<A>, f: (a: A) => Option<A>): Effect<void>;
}

Signature

declare const updateSomeAndGet: {
<A>(pf: (a: A) => Option<A>): (self: Ref<A>) => Effect<A>;
<A>(self: Ref<A>, pf: (a: A) => Option<A>): Effect<A>;
}

Signature

declare const updateSomeAndGetEffect: {
<A, R, E>(pf: (a: A) => Option<Effect<A, E, R>>): (self: SynchronizedRef<A>) => Effect<A, E, R>;
<A, R, E>(self: SynchronizedRef<A>, pf: (a: A) => Option<Effect<A, E, R>>): Effect<A, E, R>;
}

Signature

declare const updateSomeEffect: {
<A, R, E>(pf: (a: A) => Option<Effect<A, E, R>>): (self: SynchronizedRef<A>) => Effect<void, E, R>;
<A, R, E>(self: SynchronizedRef<A>, pf: (a: A) => Option<Effect<A, E, R>>): Effect<void, E, R>;
}