Skip to content
Effect Days 2026 Get your ticket

TSubscriptionRef

20 exports Added in v3.10.0 Source

Constructors

make

Added in v3.10.0 Source

Signature

declare const make: <A>(value: A) => STM.STM<TSubscriptionRef<A>>

Models

TSubscriptionRef interface

Added in v3.10.0 Source

A TSubscriptionRef<A> is a TRef that can be subscribed to in order to receive a TDequeue<A> of the current value and all committed changes to the value.

Signature

interface TSubscriptionRef<in out A> extends Variance<A>, TRef<A> {
  readonly changes: STM<TDequeue<A>>;
}

Mutations

changes

Added in v3.10.0 Source

Signature

declare const changes: <A>(self: TSubscriptionRef<A>) => STM.STM<TQueue.TDequeue<A>>

changesScoped

Added in v3.10.0 Source

Signature

declare const changesScoped: <A>(self: TSubscriptionRef<A>) => Effect.Effect<TQueue.TDequeue<A>, never, Scope.Scope>

changesStream

Added in v3.10.0 Source

Signature

declare const changesStream: <A>(self: TSubscriptionRef<A>) => Stream.Stream<A>

get

Added in v3.10.0 Source

Signature

declare const get: <A>(self: TSubscriptionRef<A>) => STM.STM<A>

getAndSet

Added in v3.10.0 Source

Signature

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

getAndUpdate

Added in v3.10.0 Source

Signature

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

getAndUpdateSome

Added in v3.10.0 Source

Signature

declare const getAndUpdateSome: {
  <A>(f: (a: A) => Option<A>): (self: TSubscriptionRef<A>) => STM<A>;
  <A>(self: TSubscriptionRef<A>, f: (a: A) => Option<A>): STM<A>;
}

modify

Added in v3.10.0 Source

Signature

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

modifySome

Added in v3.10.0 Source

Signature

declare const modifySome: {
  <A, B>(fallback: B, f: (a: A) => Option<readonly [B, A]>): (self: TSubscriptionRef<A>) => STM<B>;
  <A, B>(self: TSubscriptionRef<A>, fallback: B, f: (a: A) => Option<readonly [B, A]>): STM<B>;
}

set

Added in v3.10.0 Source

Signature

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

setAndGet

Added in v3.10.0 Source

Signature

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

update

Added in v3.10.0 Source

Signature

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

updateAndGet

Added in v3.10.0 Source

Signature

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

updateSome

Added in v3.10.0 Source

Signature

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

updateSomeAndGet

Added in v3.10.0 Source

Signature

declare const updateSomeAndGet: {
  <A>(f: (a: A) => Option<A>): (self: TSubscriptionRef<A>) => STM<A>;
  <A>(self: TSubscriptionRef<A>, f: (a: A) => Option<A>): STM<A>;
}

Other

Symbols

TSubscriptionRefTypeId

Added in v3.10.0 Source

Signature

declare const TSubscriptionRefTypeId: unique symbol

TSubscriptionRefTypeId type

Added in v3.10.0 Source

Signature

type TSubscriptionRefTypeId = typeof TSubscriptionRefTypeId