Skip to main content Link Search Menu Expand Document (external link)

Ref overview

Added in v2.0.0


Table of contents


constructors

make

Signature

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

Added in v2.0.0

getters

get

Signature

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

Added in v2.0.0

models

Ref (interface)

Signature

export interface Ref<in out A> extends Ref.Variance<A>, Readable<A> {
  modify<B>(f: (a: A) => readonly [B, A]): Effect.Effect<B>
}

Added in v2.0.0

Ref (namespace)

Added in v2.0.0

Variance (interface)

Signature

export interface Variance<in out A> {
  readonly [RefTypeId]: {
    readonly _A: Types.Invariant<A>
  }
}

Added in v2.0.0

symbols

RefTypeId

Signature

export declare const RefTypeId: typeof RefTypeId

Added in v2.0.0

RefTypeId (type alias)

Signature

export type RefTypeId = typeof RefTypeId

Added in v2.0.0

unsafe

unsafeMake

Signature

export declare const unsafeMake: <A>(value: A) => Ref<A>

Added in v2.0.0

utils

getAndSet

Signature

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

Added in v2.0.0

getAndUpdate

Signature

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

Added in v2.0.0

getAndUpdateSome

Signature

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

Added in v2.0.0

modify

Signature

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

Added in v2.0.0

modifySome

Signature

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

Added in v2.0.0

set

Signature

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

Added in v2.0.0

setAndGet

Signature

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

Added in v2.0.0

update

Signature

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

Added in v2.0.0

updateAndGet

Signature

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

Added in v2.0.0

updateSome

Signature

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

Added in v2.0.0

updateSomeAndGet

Signature

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

Added in v2.0.0