Skip to content
Effect Days 2026 Get your ticket

Ref

20 exports Added in v2.0.0 Source

Constructors

make

Added in v2.0.0 Source

Signature

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

Getters

get

Added in v2.0.0 Source

Signature

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

Models

Ref

Added in v2.0.0 Source

Ref interface

Added in v2.0.0 Source

Signature

interface Ref<in out A> extends Variance<A>, Effect<A>, Readable<A> {
readonly [ignoreSymbol]?: RefUnifyIgnore;
readonly [typeSymbol]?: unknown;
readonly [unifySymbol]?: RefUnify<Ref<A>>;
modify<B>(f: (a: A) => readonly [B, A]): Effect<B>;
}

RefUnify interface

Added in v3.8.0 Source

Signature

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

RefUnifyIgnore interface

Added in v3.8.0 Source

Signature

interface RefUnifyIgnore extends EffectUnifyIgnore {
Effect?: true;
}

Symbols

RefTypeId

Added in v2.0.0 Source

Signature

declare const RefTypeId: unique symbol

RefTypeId type

Added in v2.0.0 Source

Signature

type RefTypeId = typeof RefTypeId

Unsafe

unsafeMake

Added in v2.0.0 Source

Signature

declare const unsafeMake: <A>(value: A) => Ref<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 getAndUpdateSome: {
<A>(pf: (a: A) => Option<A>): (self: Ref<A>) => Effect<A>;
<A>(self: Ref<A>, pf: (a: A) => Option<A>): Effect<A>;
}

modify

Added in v2.0.0 Source

Signature

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

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>;
}

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>;
}

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>;
}