Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/fx

RefString.make

Creates a new RefString from a string, Effect, or Fx.

Package version
2.0.0-beta.7
Category
Constructors
Since
1.18.0
Member of
RefString

Import

import { RefString } from "@typed/fx";

Access RefString.make through the imported RefString export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export declare function make<E = never, R = never>(initial: string | Effect.Effect<string, E, R> | Fx.Fx<string, E, R>, eq?: Equivalence<string>): Effect.Effect<RefString<E>, never, R | Scope.Scope>;

Why

Creates string state with equality suited to that Effect data type, so unchanged values do not produce redundant pushed updates.

Ownership and lifetime

The creation Effect requires Scope. It owns initializer acquisition, live source subscriptions, and cleanup; source failures and services stay on reads and pushes.

Examples

import { Effect } from "effect"
import * as RefString from "@typed/fx/RefString"

const program = Effect.gen(function* () {
  const value = yield* RefString.make("hello")
  const current = yield* value
  console.log(current) // "hello"
})

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source