RefSubject

Import

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

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

Signatures

export * as RefSubject from "./RefSubject.js";

Members

• RefSubject.Computed

  A Computed is a read-only view of a value that can change over time. It is an Fx that emits the current value and subsequent updates. It is also an Effect that samples the current value.

• RefSubject.ComputedTypeId

  Runtime symbol identifying read-only Computed values.

• RefSubject.CurrentComputedBehavior

  Selects whether a computed Fx observes only its current value or also follows later pushes.

• RefSubject.Error

  Describes the error type.

• RefSubject.Filtered

  A Filtered is a Computed that may not always have a value. It is essentially a Computed<Option<A>> with helper methods.

• RefSubject.FilteredTypeId

  Runtime symbol identifying conditionally available Filtered values.

• RefSubject.GetSetDelete

  Interface for basic RefSubject operations: get, set, delete.

• RefSubject.HYDRATION_ATTRIBUTE

  Canonical data attribute for the versioned envelope of unnamed hydrated refs.

• RefSubject.HydrateOptions

  Defines the hydrate options state contract.

• RefSubject.HydratedRefSubject

  Defines the hydrated ref subject state contract.

• RefSubject.HydrationAttribute

  Defines the hydration attribute state contract.

• RefSubject.HydrationElement

  Defines the hydration element state contract.

• RefSubject.HydrationRef

  Defines the hydration ref state contract.

• RefSubject.HydrationRefTypeId

  Runtime symbol exposing hydration metadata on a hydrated RefSubject.

• RefSubject.Identifier

  Describes the identifier type.

• RefSubject.RefSubject

  A RefSubject is a mutable reference that can be observed as an Fx. It combines the capabilities of a Ref (get/set/update) with a Subject (subscribe).

• RefSubject.RefSubjectOptions

  Defines the ref subject options state contract.

• RefSubject.RefSubjectTypeId

  Runtime symbol identifying writable RefSubject values.

• RefSubject.Service

  Creates a Context-backed RefSubject service facade and Layer constructors.

• RefSubject.Services

  Describes the services type.

• RefSubject.Success

  Describes the success type.

• RefSubject.compact

  Converts a Computed or Filtered of Option<A> into a Filtered<A>, filtering out None values.

• RefSubject.computedFromService

  Lifts an Effect-provided Computed into a Computed facade.

• RefSubject.decrement

  Decrements a numeric RefSubject by 1.

• RefSubject.delete

  Resets a RefSubject to its initial value, returning the previous value if it existed.

• RefSubject.filterMap

  Filters and transforms a RefSubject, Computed, or Filtered using a pure function that returns an Option.

• RefSubject.filterMapEffect

  Filters and transforms a RefSubject, Computed, or Filtered using an Effectful function that returns an Option.

• RefSubject.filteredFromService

  Defers retrieval of a Filtered value from Effect Context while preserving Filtered behavior.

• RefSubject.fromEffect

  Creates a RefSubject from an Effect.

• RefSubject.fromFx

  Creates a RefSubject from an Fx, tracking the latest emitted value.

• RefSubject.fromNullable

  Creates Option-valued RefSubject state from a nullable input.

• RefSubject.fromOption

  Creates a RefSubject from an Option value.

• RefSubject.fromStream

  Creates a RefSubject that tracks the latest value emitted by an Effect Stream.

• RefSubject.getOrElse

  Returns a Computed that yields the value inside the Option, or the fallback when None. Works with Computed<Option<A>> (e.g. from fromOption / fromNullable) and with Filtered<A>.

• RefSubject.hydrate

  Creates a named hydrated RefSubject using a string-encoded Schema codec.

• RefSubject.hydrateAll

  Combines hydrated refs into one serialization and restoration boundary.

• RefSubject.increment

  Increments a numeric RefSubject by 1.

• RefSubject.isComputed

  Tests whether a value carries the public Computed TypeId.

• RefSubject.isHydrationRef

  Tests whether a value carries callable hydration metadata.

• RefSubject.isRefSubject

  Checks if a value is a RefSubject.

• RefSubject.make

  Creates a new RefSubject from a value, Effect, or Fx.

• RefSubject.makeComputed

  Builds a read-only Computed projection from a Versioned source.

• RefSubject.makeFiltered

  Builds a Filtered view from the three channels of a Versioned source.

• RefSubject.map

  Transforms a RefSubject, Computed, or Filtered using a pure function.

• RefSubject.mapEffect

  Transforms a RefSubject, Computed, or Filtered using an Effectful function.

• RefSubject.modify

  Modifies a RefSubject using a pure function that returns both a result and a new value.

• RefSubject.modifyEffect

  Modifies a RefSubject using an Effectful function that returns both a result and a new value.

• RefSubject.proxy

  Extract all values from an object using a Proxy. Allows accessing nested properties of a Computed or Filtered object/array as individual computed values.

• RefSubject.reset

  Resets a RefSubject to its initial value, returning the previous value if it existed.

• RefSubject.runUpdates

  Runs an effect that can modify a RefSubject transactionally, with optional interrupt handling.

• RefSubject.scan

  Stateful scan over a RefSubject / Computed, producing a Computed of the accumulated state.

  Fx subscriptions follow Fx.scan semantics (emit initial, then fold each source value). Effect sampling accumulates across source versions via a private state ref (do not mix heavy subscribe + sample on the same scan if you need a single shared accumulator).

• RefSubject.scanEffect

  Effectful stateful scan over a RefSubject / Computed, producing a Computed of the accumulated state.

• RefSubject.set

  Sets the value of a RefSubject.

• RefSubject.slice

  Limits which pushed versions a RefSubject view observes without changing its state.

• RefSubject.struct

  Combines multiple RefSubject, Computed, or Filtered instances into a single struct.

• RefSubject.transform

  Transforms a RefSubject invariantly using bidirectional mapping functions.

• RefSubject.tuple

  Combines multiple RefSubject, Computed, or Filtered instances into a single tuple.

• RefSubject.update

  Updates a RefSubject using a pure function.

• RefSubject.updateEffect

  Updates a RefSubject using an Effectful function.

Source

• packages/fx/src/RefSubject.ts:1