Accumulation
RefSubject.scanvariable · Re-export
Stateful scan over a
RefSubject/Computed, producing aComputedof the accumulated state.Fx subscriptions follow
Fx.scansemantics (emitinitial, 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.scanEffectvariable · Re-export
Effectful stateful scan over a
RefSubject/Computed, producing aComputedof the accumulated state.
Arithmetic queries
RefBigDecimal.absvariable · Re-export
Get the absolute value of the current state of a RefBigDecimal.
RefBigDecimal.addvariable · Re-export
Add a BigDecimal to the current state of a RefBigDecimal.
RefBigDecimal.ceilvariable · Re-export
Calculate the ceiling of the current state of a RefBigDecimal.
RefBigDecimal.dividevariable · Re-export
Divide the current state of a RefBigDecimal by a BigDecimal.
RefBigDecimal.equalsvariable · Re-export
Check if the current state of a RefBigDecimal equals a BigDecimal.
RefBigDecimal.floorvariable · Re-export
Calculate the floor of the current state of a RefBigDecimal.
RefBigDecimal.multiplyvariable · Re-export
Multiply the current state of a RefBigDecimal by a BigDecimal.
RefBigDecimal.negatevariable · Re-export
Negate the current state of a RefBigDecimal.
RefBigDecimal.roundvariable · Re-export
Round the current state of a RefBigDecimal.
RefBigDecimal.subtractvariable · Re-export
Subtract a BigDecimal from the current state of a RefBigDecimal.
RefBigDecimal.truncatevariable · Re-export
Truncate the current state of a RefBigDecimal.
RefBigInt.absvariable · Re-export
Get the absolute value of the current state of a RefBigInt.
RefBigInt.addvariable · Re-export
Add a BigInt to the current state of a RefBigInt.
RefBigInt.dividevariable · Re-export
Divide the current state of a RefBigInt by a BigInt.
RefBigInt.equalsvariable · Re-export
Check if the current state of a RefBigInt equals a BigInt.
RefBigInt.modvariable · Re-export
Get the remainder of dividing the current state of a RefBigInt by a BigInt.
RefBigInt.multiplyvariable · Re-export
Multiply the current state of a RefBigInt by a BigInt.
RefBigInt.negatevariable · Re-export
Negate the current state of a RefBigInt.
RefBigInt.subtractvariable · Re-export
Subtract a BigInt from the current state of a RefBigInt.
RefDuration.addvariable · Re-export
Add a Duration to the current state of a RefDuration.
RefDuration.dividevariable · Re-export
Divide the current state of a RefDuration by a number.
RefDuration.multiplyvariable · Re-export
Multiply the current state of a RefDuration by a number.
RefDuration.subtractvariable · Re-export
Subtract a Duration from the current state of a RefDuration.
Bidirectional contracts
Push.Pushinterface · Re-export
A bidirectional value that is both a
Sink<A, E, R>and anFx<B, E2, R2>.Calling
onSuccessoronFailuresends exactly one input notification to the wrapped Sink. The returnedEffectis the acknowledgment: a producer that runs and awaits it waits for the consumer callback to finish.Pushadds no queue, buffering, replay, or demand protocol of its own.Running the Fx side preserves that Fx’s cardinality and ordering. Input values are not automatically forwarded to the output; any relationship between the two sides belongs to the supplied Sink and Fx (for example, a shared
Subject).
Callback protocol
Fx.Emittype-alias · Re-export
Operations supplied to a callback producer for emitting values or ending its run.
Callback sources
Fx.callbackvariable · Re-export
Creates an Fx from a callback-based source.
Fx.makevariable · Re-export
Creates an Fx from a function that provides values to a Sink.
This is the lowest-level constructor for Fx, giving you full control over the stream’s behavior.
Channel transformations
Versioned.mapvariable · Re-export
Transform a Versioned’s output value as both an Fx and Effect.
Versioned.mapEffectvariable · Re-export
Transform a Versioned’s output value as both an Fx and Effect using an Effect.
Versioned.transformfunction · Re-export
Transforms a Versioned value into another Versioned value.
Collecting values
Fx.collectAllvariable · Re-export
Collects all values emitted by an
Fxinto an array.Fx.collectAllForkvariable · Re-export
Forks the collection of all values from an
Fx.Fx.collectUpTovariable · Re-export
Collects the first
nvalues emitted by anFxinto an array.Fx.collectUpToForkvariable · Re-export
Forks the collection of up to
nvalues from anFx.Fx.firstfunction · Re-export
Returns the first value emitted by the
Fxwrapped in anOption. If theFxis empty, returnsNone.Sink.collectfunction · Re-export
Collects all values into an array. Pass a
Ref<ReadonlyArray<A>>(e.g.Ref.make([])); after running, read the result withRef.get(ref).Sink.headfunction · Re-export
Keeps only the first value. Pass a
Ref<Option.Option<A>>(e.g.Ref.make(Option.none())); after running, read the result withRef.get(ref).Sink.lastfunction · Re-export
Keeps only the last value. Pass a
Ref<Option.Option<A>>(e.g.Ref.make(Option.none())); after running, read the result withRef.get(ref).Sink.reducefunction · Re-export
Reduces values into a single result using a pure function. Pass a
Ref<B>(e.g. fromRef.make(initial)); after running, read the result withRef.get(ref).Sink.reduceEffectfunction · Re-export
Reduces values into a single result using an effectful function. Pass a
Ref<B>; after running, read the result withRef.get(ref). If the reducer effect fails, the ref is left unchanged (Sink onSuccess is typed as never failing).
Combining sources
Fx.appendvariable · Re-export
Appends a value to the end of an Fx.
Fx.concatvariable · Re-export
Concatenates two Fx streams: runs the first to completion, then runs the second. Emits all values from the first stream in order, then all values from the second stream in order.
Completion: The concatenated stream completes when the second stream completes (the first must complete before the second starts).
Failures: A source Cause is delivered to the Sink. Because
Fx.runis infallible, delivery alone does not suppress the continuation: the right source is run after the left run returns.Fx.continueWithvariable · Re-export
Continues an Fx with a lazily created Fx after the first run returns.
Fx.delimitvariable · Re-export
Wraps an Fx with a start and end value.
Fx.mergevariable · Re-export
Merges two Fx streams into a single Fx that emits values from both streams concurrently. Order of emission is non-deterministic.
Completion: The merged stream completes when both input streams have completed.
Failures: Every failure Cause is delivered to the downstream Sink. Delivery does not make
Fx.runfail, somergedoes not itself cancel the sibling; a terminal observer may choose to.Fx.mergeAllvariable · Re-export
Merges multiple Fx streams into a single Fx that emits values from all input streams concurrently.
Fx.mergeLeftvariable · Re-export
Merges two Fx streams and emits only values from the left stream. Both streams run concurrently; completion when both complete.
Fx.mergeOrderedfunction · Re-export
Runs multiple Fx streams concurrently while draining their values in argument order.
Fx.mergeRightvariable · Re-export
Merges two Fx streams and emits only values from the right stream. Both streams run concurrently; completion when both complete.
Fx.prependvariable · Re-export
Prepends a value to the beginning of an Fx.
Fx.structfunction · Re-export
Combines a record of Fx streams into a single Fx that emits a record of the latest values. Similar to
tuple, but for objects.Fx.tuplefunction · Re-export
Combines multiple Fx streams into a single Fx that emits a tuple of the latest values from each stream. The resulting Fx waits for all input streams to emit at least once before emitting the first tuple. Afterwards, it emits a new tuple whenever any input stream emits a new value.
Fx.withLatestFromvariable · Re-export
Emits
[source, latest]whenever the source emits, using the latest value fromthat. Source values are dropped untilthathas emitted at least once.Unlike {@link zipLatest}, this does not emit when
thatupdates.Completion: Completes when the source completes. Errors: The first failure from either stream fails the result.
Fx.withLatestFromWithvariable · Re-export
Like {@link withLatestFrom}, but combines the pair with
f.Fx.zipvariable · Re-export
Zips two Fx streams in strict lockstep: emits a pair
[a, b]only when both streams have produced their next value. Emits the i-th pair when both have produced at least i values.Completion: The zipped stream completes when the first of the two streams completes (no further pairs are emitted). The other stream is interrupted.
Errors: The first failure from either stream fails the zipped stream.
Fx.zipLatestvariable · Re-export
Zips two Fx streams by latest values: waits for both to emit at least once, then emits
[left, right]whenever either stream emits (using the latest value from the other). No strict pairing; output count is the sum of emissions from both after the first pair.Completion: Completes when both streams have completed. Errors: The first failure from either stream fails the result.
Fx.zipLatestWithvariable · Re-export
Zips two Fx streams by latest values and combines each pair with a function. Waits for both to emit at least once, then emits
f(left, right)whenever either stream emits.Completion: Completes when both streams have completed. Errors: The first failure from either stream fails the result.
Fx.zipLeftvariable · Re-export
Zips two Fx streams in strict lockstep and emits only the left value. Completes when the first of the two streams completes.
Fx.zipRightvariable · Re-export
Zips two Fx streams in strict lockstep and emits only the right value. Completes when the first of the two streams completes.
Fx.zipWithvariable · Re-export
Zips two Fx streams in strict lockstep and combines each pair with a function. Emits
f(a, b)when both streams have produced their next value.Completion: Completes when the first of the two streams completes. Errors: The first failure from either stream fails the result.
Concurrent output work
Push.exhaustLatestMapvariable · Re-export
Runs one inner Fx at a time and retains only the latest value received while busy.
A value while idle starts immediately. While its inner runs, newer outer values replace a single pending slot.
f(value)is evaluated and an inner Fx is constructed before every replacement; a superseded pending Fx is never run. After completion, only the latest pending Fx starts. Accepted inners preserve their own order and all values. The input Sink is unchanged.Push.exhaustLatestMapEffectvariable · Re-export
Runs one mapped Effect at a time and retains only the latest value received while busy.
Each accepted Effect can emit one result. While it runs, one pending Effect is repeatedly overwritten; after completion only the latest pending Effect starts. The mapping callback still runs and constructs an Effect for every value before replacement; superseded Effects are not run. The input side is unchanged.
Push.exhaustMapvariable · Re-export
Runs at most one inner Fx and ignores outer values while it is active.
The first value seen while idle starts an inner; every value arriving before that inner completes is dropped.
f(value)is still evaluated and its inner Fx is constructed before the busy check; dropping means the returned Fx is not run. Accepted inners preserve their own order and all values. Input is unchanged.Push.exhaustMapEffectvariable · Re-export
Runs at most one mapped Effect and ignores values while it is active.
The first value while idle starts one Effect and can emit one result; all values received before it completes are dropped. The mapping callback is still invoked and constructs an Effect for every value before the busy check; dropped Effects are not run. The input side is unchanged.
Push.flatMapvariable · Re-export
Transforms each output value into an inner
Fxand merges all inners concurrently.Every outer value starts one inner. All inner values are emitted; order within each inner is preserved, but values from different inners may interleave. The outer stream waits for all inners before normal completion. The input Sink is unchanged.
Push.flatMapEffectvariable · Re-export
Transforms every output value into an Effect and merges their results concurrently.
One Effect starts per outer value and can emit one result. All successful results are emitted, but concurrent completion order may differ from input order. The input side is unchanged.
Push.switchMapvariable · Re-export
Transforms each output value into an inner
Fx, observing only the latest one.A new outer value interrupts the previous inner fiber before starting the next. Output cardinality is the cardinality of the successive active inners; values from an interrupted inner stop. Outer order determines replacement order, while each active inner preserves its own order. The input Sink is unchanged.
Push.switchMapEffectvariable · Re-export
Transforms each output value into an Effect, keeping only the latest Effect.
Each new outer value interrupts the previous Effect before starting its own. Every Effect can emit at most one value; interrupted Effects emit none. The input side is unchanged.
Concurrent work
Fx.concatMapvariable · Re-export
Maps each element to an inner Fx and concatenates the results sequentially.
Fx.concatMapEffectvariable · Re-export
Maps each element to an Effect and concatenates the results sequentially.
Fx.exhaustLatestMapvariable · Re-export
Maps each element to an inner Fx, running one now and retaining only the latest waiting value.
Fx.exhaustLatestMapEffectvariable · Re-export
Maps each element to an Effect, running one now and retaining only the latest waiting value.
Fx.exhaustMapvariable · Re-export
Maps each element of an Fx to a new Fx, ignoring new elements until the current inner Fx completes.
Fx.exhaustMapEffectvariable · Re-export
Maps each element of an Fx to an Effect, ignoring new elements until the current effect completes.
Fx.flatMapvariable · Re-export
Maps each source value to an inner Fx and merges every inner concurrently.
Fx.flatMapConcurrentlyvariable · Re-export
Maps each element of an Fx to a new Fx, running them concurrently with a limit.
Fx.flatMapConcurrentlyEffectvariable · Re-export
Maps each element of an Fx to an Effect, running them concurrently with a limit.
Fx.flatMapEffectvariable · Re-export
Maps each element of an Fx to an Effect, and merges the results.
Fx.racevariable · Re-export
Runs two streams concurrently until one emits, then mirrors the winner and interrupts the other.
A failure or completion from one side before the other emits does not win unless every side ends without emitting. After a winner is chosen, that stream’s later failures are propagated.
Fx.raceAllvariable · Re-export
Races many streams: the first to emit wins and the rest are interrupted.
Fx.switchMapvariable · Re-export
Maps each element of an Fx to a new Fx, and switches to the latest inner Fx.
When a new element is emitted, the previous inner Fx is cancelled.
Fx.switchMapEffectvariable · Re-export
Maps each element of an Fx to an Effect, and switches to the latest effect.
When a new element is emitted, the previous effect is cancelled.
Conditional sources
Construction options
RefSubject.RefSubjectOptionsinterface · Re-export
Defines the ref subject options state contract.
Constructors
RefArray.makefunction · Re-export
Creates a new
RefArrayfrom an array,Effect, orFx.RefBigDecimal.makefunction · Re-export
Creates a new
RefBigDecimalfrom a BigDecimal,Effect, orFx.RefBigInt.makefunction · Re-export
Creates a new
RefBigIntfrom a BigInt,Effect, orFx.RefBoolean.makefunction · Re-export
Creates a new
RefBooleanfrom a boolean,Effect, orFx.RefCause.makefunction · Re-export
Creates a new
RefCausefrom a Cause,Effect, orFx.RefChunk.makefunction · Re-export
Creates a new
RefChunkfrom a Chunk,Effect, orFx.RefDateTime.makefunction · Re-export
Creates a new
RefDateTimefrom a DateTime,Effect, orFx.RefDuration.makefunction · Re-export
Creates a new
RefDurationfrom a Duration,Effect, orFx.RefGraph.directedfunction · Re-export
Creates a new empty directed RefGraph.
RefGraph.makefunction · Re-export
Creates a new
RefGraphfrom a Graph,Effect, orFx.RefGraph.undirectedfunction · Re-export
Creates a new empty undirected RefGraph.
RefHashMap.makefunction · Re-export
Creates a new
RefHashMapfrom a HashMap,Effect, orFx.RefHashRing.emptyfunction · Re-export
Creates a new empty RefHashRing.
RefHashRing.makefunction · Re-export
Creates a new
RefHashRingfrom a HashRing,Effect, orFx.RefHashSet.makefunction · Re-export
Creates a new
RefHashSetfrom a HashSet,Effect, orFx.RefIterable.makefunction · Re-export
Creates a new
RefIterablefrom an Iterable,Effect, orFx.RefOption.makefunction · Re-export
Creates a new
RefOptionfrom an Option,Effect, orFx.RefRecord.makefunction · Re-export
Creates a new
RefRecordfrom a Record,Effect, orFx.RefResult.makefunction · Re-export
Creates a new
RefResultfrom a Result,Effect, orFx.RefString.makefunction · Re-export
Creates a new
RefStringfrom a string,Effect, orFx.RefStruct.makefunction · Re-export
Creates a new
RefStructfrom a struct,Effect, orFx.RefSubject.makefunction · Re-export
Creates a new
RefSubjectfrom a value,Effect, orFx.RefTrie.makefunction · Re-export
Creates a new
RefTriefrom a Trie,Effect, orFx.RefTuple.makefunction · Re-export
Creates a new
RefTuplefrom a tuple,Effect, orFx.Versioned.makefunction · Re-export
Creates a Versioned value from its components.
Versioned.offunction · Re-export
Creates a Versioned value from a constant.
Consumer contracts
Sink.Sinkinterface · Re-export
Consumes pushed successes and failures through effectful callbacks.
Date arithmetic
RefDateTime.addvariable · Re-export
Add a Duration to the current state of a RefDateTime.
RefDateTime.addDurationvariable · Re-export
Add a Duration to the current state of a RefDateTime.
RefDateTime.subtractvariable · Re-export
Subtract a Duration from the current state of a RefDateTime.
RefDateTime.subtractDurationvariable · Re-export
Subtract a Duration from the current state of a RefDateTime.
Date formatting
RefDateTime.epochMillisvariable · Re-export
Get the epoch milliseconds of the current state of a RefDateTime.
RefDateTime.formatvariable · Re-export
Format the current state of a RefDateTime.
Derived queries
RefArray.filterValuesvariable · Re-export
Filter the values of a RefArray using a predicate creating a Computed value.
RefArray.groupByvariable · Re-export
Group the values of a RefArray by a key.
RefArray.lengthvariable · Re-export
Get the current length of a RefArray.
RefArray.mapValuesvariable · Re-export
Map the values with their indexes of a RefArray.
RefArray.partitionvariable · Re-export
Partition the values of a RefArray using a predicate.
RefArray.reducevariable · Re-export
Reduce the values of a RefArray to a single value.
RefArray.reduceRightvariable · Re-export
Reduce the values of a RefArray to a single value in reverse order.
RefBigDecimal.signvariable · Re-export
Get the sign of the current state of a RefBigDecimal.
RefBoolean.andvariable · Re-export
Apply AND operation with a boolean to the current state of a RefBoolean.
RefBoolean.eqvvariable · Re-export
Apply EQV (XNOR) operation with a boolean to the current state of a RefBoolean.
RefBoolean.impliesvariable · Re-export
Apply implication operation with a boolean to the current state of a RefBoolean.
RefBoolean.nandvariable · Re-export
Apply NAND operation with a boolean to the current state of a RefBoolean.
RefBoolean.norvariable · Re-export
Apply NOR operation with a boolean to the current state of a RefBoolean.
RefBoolean.notvariable · Re-export
Apply NOT operation to the current state of a RefBoolean.
RefBoolean.orvariable · Re-export
Apply OR operation with a boolean to the current state of a RefBoolean.
RefBoolean.xorvariable · Re-export
Apply XOR operation with a boolean to the current state of a RefBoolean.
RefCause.reasonsvariable · Re-export
Get the reasons array of the current state of a RefCause.
RefCause.sizevariable · Re-export
Get the size (number of failures) of the current state of a RefCause.
RefChunk.filterValuesvariable · Re-export
Filter the values of a RefChunk creating a Computed value.
RefChunk.mapValuesvariable · Re-export
Map the values of a RefChunk to a different type.
RefChunk.partitionvariable · Re-export
Partition the values of a RefChunk using a predicate.
RefChunk.reducevariable · Re-export
Reduce the values of a RefChunk to a single value.
RefChunk.reduceRightvariable · Re-export
Reduce the values of a RefChunk in reverse order.
RefChunk.sizevariable · Re-export
Get the current size of a RefChunk.
RefGraph.connectedComponentsvariable · Re-export
Get connected components (undirected only).
RefGraph.edgeCountvariable · Re-export
Get the edge count.
RefGraph.neighborsvariable · Re-export
Get neighbors of a node.
RefGraph.neighborsDirectedvariable · Re-export
Get directed neighbors of a node.
RefGraph.nodeCountvariable · Re-export
Get the node count.
RefGraph.stronglyConnectedComponentsvariable · Re-export
Get strongly connected components.
RefHashMap.entriesvariable · Re-export
Get all entries from the RefHashMap.
RefHashMap.filterMapValuesvariable · Re-export
Filter and map values.
RefHashMap.filterValuesvariable · Re-export
Filter entries creating a Computed value.
RefHashMap.keysvariable · Re-export
Get all keys from the RefHashMap.
RefHashMap.mapValuesvariable · Re-export
Map values to a different type.
RefHashMap.reducevariable · Re-export
Reduce the entries to a single value.
RefHashMap.sizevariable · Re-export
Get the current size of the RefHashMap.
RefHashMap.valuesvariable · Re-export
Get all values from the RefHashMap.
RefHashRing.getNodevariable · Re-export
Get the node which should handle a given input string as a Computed. Returns undefined if the ring is empty.
RefHashRing.getShardsvariable · Re-export
Get shard distribution across nodes.
RefHashRing.sizevariable · Re-export
Get the number of nodes in the HashRing.
RefHashRing.valuesvariable · Re-export
Get all nodes as an array.
RefHashSet.filterValuesvariable · Re-export
Filter values creating a Computed value.
RefHashSet.mapValuesvariable · Re-export
Map values to a different type.
RefHashSet.reducevariable · Re-export
Reduce the values to a single value.
RefHashSet.sizevariable · Re-export
Get the current size of the RefHashSet.
RefHashSet.valuesvariable · Re-export
Get all values as an array.
RefIterable.countByvariable · Re-export
Count elements satisfying a predicate.
RefIterable.filterValuesvariable · Re-export
Filter the values of a RefIterable creating a Computed value.
RefIterable.groupByvariable · Re-export
Group the values of a RefIterable by a key.
RefIterable.mapValuesvariable · Re-export
Map the values of a RefIterable to a different type.
RefIterable.reducevariable · Re-export
Reduce the values of a RefIterable to a single value.
RefIterable.sizevariable · Re-export
Get the current size of a RefIterable.
RefIterable.toArrayvariable · Re-export
Convert to array.
RefOption.filtervariable · Re-export
Filter the value inside the Option of a RefOption.
RefOption.flatMapvariable · Re-export
FlatMap the value inside the Option of a RefOption.
RefOption.getOrElsevariable · Re-export
Get the value from the Option or use a fallback value.
RefOption.mapvariable · Re-export
Map the value inside the Option of a RefOption.
RefRecord.entriesvariable · Re-export
Get all entries from the Record.
RefRecord.filterMapValuesvariable · Re-export
Filter and map values.
RefRecord.filterValuesvariable · Re-export
Filter entries creating a Computed value.
RefRecord.keysvariable · Re-export
Get all keys from the Record.
RefRecord.mapEntriesvariable · Re-export
Map entries to new key-value pairs.
RefRecord.mapKeysvariable · Re-export
Map keys to different keys.
RefRecord.mapValuesvariable · Re-export
Map values to a different type.
RefRecord.partitionvariable · Re-export
Partition entries.
RefRecord.reducevariable · Re-export
Reduce the entries to a single value.
RefRecord.sizevariable · Re-export
Get the current size of the Record.
RefRecord.valuesvariable · Re-export
Get all values from the Record.
RefResult.flatMapvariable · Re-export
FlatMap the success value of a RefResult.
RefResult.mapvariable · Re-export
Map the success value of a RefResult.
RefResult.mapErrorvariable · Re-export
Map the error value of a RefResult.
RefResult.matchvariable · Re-export
Match on the Result value.
RefString.concatvariable · Re-export
Concatenate a string to the current state of a RefString.
RefString.endsWithvariable · Re-export
Check if the current state of a RefString ends with a substring.
RefString.includesvariable · Re-export
Check if the current state of a RefString includes a substring.
RefString.lengthvariable · Re-export
Get the length of the current state of a RefString.
RefString.replacevariable · Re-export
Replace the first occurrence of a substring or pattern in the current state of a RefString.
RefString.replaceAllvariable · Re-export
Replace all occurrences of a substring or pattern in the current state of a RefString.
RefString.slicevariable · Re-export
Extract a section of the current state of a RefString.
RefString.startsWithvariable · Re-export
Check if the current state of a RefString starts with a substring.
RefString.toLowerCasevariable · Re-export
Convert the current state of a RefString to lowercase.
RefString.toUpperCasevariable · Re-export
Convert the current state of a RefString to uppercase.
RefString.trimvariable · Re-export
Trim whitespace from both ends of the current state of a RefString.
RefString.trimEndvariable · Re-export
Trim whitespace from the end of the current state of a RefString.
RefString.trimStartvariable · Re-export
Trim whitespace from the start of the current state of a RefString.
RefStruct.entriesvariable · Re-export
Get the entries of the current state of a RefStruct.
RefStruct.getvariable · Re-export
Get a property value from the current state of a RefStruct.
RefStruct.keysvariable · Re-export
Get the keys of the current state of a RefStruct.
RefStruct.omitvariable · Re-export
Omit properties from the current state of a RefStruct.
RefStruct.pickvariable · Re-export
Pick properties from the current state of a RefStruct.
RefStruct.sizevariable · Re-export
Get the size (number of properties) of the current state of a RefStruct.
RefStruct.valuesvariable · Re-export
Get the values of the current state of a RefStruct.
RefSubject.makeComputedfunction · Re-export
Builds a read-only Computed projection from a Versioned source.
RefSubject.mapvariable · Re-export
Transforms a
RefSubject,Computed, orFilteredusing a pure function.RefSubject.mapEffectvariable · Re-export
Transforms a
RefSubject,Computed, orFilteredusing anEffectful function.RefSubject.proxyvariable · Re-export
Extract all values from an object using a Proxy. Allows accessing nested properties of a
ComputedorFilteredobject/array as individual computed values.RefTrie.compactvariable · Re-export
Compact Option values.
RefTrie.entriesvariable · Re-export
Get all entries from the Trie.
RefTrie.entriesWithPrefixvariable · Re-export
Get all entries with a given prefix.
RefTrie.keysvariable · Re-export
Get all keys from the Trie.
RefTrie.keysWithPrefixvariable · Re-export
Get all keys with a given prefix.
RefTrie.longestPrefixOfvariable · Re-export
Get the longest prefix of a key that exists in the Trie.
RefTrie.mapValuesvariable · Re-export
Map values to a different type.
RefTrie.reducevariable · Re-export
Reduce the entries to a single value.
RefTrie.sizevariable · Re-export
Get the current size of the Trie.
RefTrie.valuesvariable · Re-export
Get all values from the Trie.
RefTrie.valuesWithPrefixvariable · Re-export
Get all values with a given prefix.
RefTuple.appendElementvariable · Re-export
Append an element to the end of the current state of a RefTuple.
RefTuple.getvariable · Re-export
Projects one statically valid tuple index as Computed state.
RefTuple.lengthvariable · Re-export
Get the length of the current state of a RefTuple.
RefTuple.omitvariable · Re-export
Omit elements at specific indices from the current state of a RefTuple.
RefTuple.pickvariable · Re-export
Pick elements at specific indices from the current state of a RefTuple.
RefTuple.prependElementvariable · Re-export
Prepend an element to the beginning of the current state of a RefTuple.
Effect interop
Fx.fromEffectvariable · Re-export
Creates an Fx from an Effect.
If the Effect succeeds, the Fx emits the value and completes. If the Effect fails, the Fx fails with the same error.
Errors and recovery
Fx.catchvariable · Re-export
Recovers from the first typed failure of an Fx by running a fallback Fx.
Fx.catchAllvariable · Re-export
Uses the Effect-style
catchAllname for {@link catch}.Fx.catchCausevariable · Re-export
Recovers from any failure cause by running a fallback Fx.
Fx.catchCauseIfvariable · Re-export
Recovers a failure cause only when a predicate accepts the complete cause.
Fx.catchIfvariable · Re-export
Recovers a typed failure only when a predicate accepts it.
Fx.catchTagvariable · Re-export
Recovers selected tagged typed failures by running a fallback Fx.
Fx.catchTagsvariable · Re-export
Recovers several tagged typed-error variants with one handler table.
Fx.catch_variable · Re-export
Recovers from the first typed failure of an Fx by running a fallback Fx.
Fx.causesvariable · Re-export
Emits the source’s terminal failure cause and discards every successful value.
Fx.exitvariable · Re-export
Materializes every success and the terminal failure as infallible
Exitvalues.Fx.flipvariable · Re-export
Emits typed failures as values and fails with the first successful value.
Fx.mapBothvariable · Re-export
Transforms both the success and error channels of an Fx using the provided options.
Mirrors
Effect.mapBoth:onSuccessmaps emitted values,onFailuremaps the typed failure (viaCause.map); defects and interrupts are preserved.Fx.mapErrorvariable · Re-export
Transforms typed failures while preserving defects and interruption.
Fx.resultvariable · Re-export
Materializes success and failure of an Fx as
Resultvalues.- Success: each emitted value is wrapped as
Result.succeed(value). - Failure: any failure (including typed error, defect, and interrupt) is
materialized as
Result.fail(cause). The output error type isCause<E>, so defects and interrupts are explicitly represented in theResultand the resulting Fx has error typenever.
The resulting Fx never fails at the stream level; all outcomes are emitted as
Result<A, Cause<E>>. Consumers can useResult.matchorResult.isSuccess/Result.isFailureto handle success vs failure (including defect/interrupt).- Success: each emitted value is wrapped as
Fx.retryvariable · Re-export
Retries the entire stream when its Cause contains a typed
Failaccepted byschedule.The schedule is reset as soon as the first element of an attempt is emitted, matching Effect
Stream.retry.
Failure handling
Sink.exitvariable · Re-export
Materializes both sink channels as successful Effect
Exitvalues.Sink.flipvariable · Re-export
Exchanges a sink’s typed success and failure channels.
Sink.mapErrorfunction · Re-export
Maps the error channel of a sink using the provided function. Failures are mapped via
Cause.map; defects and interrupts are preserved.Sink.skipInterruptvariable · Re-export
Suppresses failure causes made entirely of interruption reasons.
Failure sources
Fx.dievariable · Re-export
Creates an Fx that immediately terminates with a defect (unexpected error).
Fx.failvariable · Re-export
Creates an Fx that immediately fails with the specified error.
Fx.failCausevariable · Re-export
Creates an Fx that immediately terminates with the specified Cause.
Fx.fromFailuresvariable · Re-export
Creates an Fx from a collection of failures (errors).
Fx.interruptvariable · Re-export
Creates an Fx that immediately interrupts.
Generator composition
Fx.fnnamespace · Re-export
Callable contracts implemented by
fn.Fx.genvariable · Re-export
Builds an Fx by yielding Effects and returning the Fx to run afterward.
Fx.genScopedvariable · Re-export
Builds an Fx with a subscription-owned Scope shared by setup and streaming.
Fx.unwrapvariable · Re-export
Unwraps an Effect that produces an Fx into a single Fx.
Fx.unwrapScopedvariable · Re-export
Unwraps an Effect that produces an Fx into a single Fx, managing the scope of the effect.
The scope of the effect is closed when the Fx completes or is interrupted.
Hydration construction
RefSubject.hydratefunction · Re-export
Creates a named hydrated RefSubject using a string-encoded Schema codec.
RefSubject.hydrateAllfunction · Re-export
Combines hydrated refs into one serialization and restoration boundary.
Hydration protocol
RefSubject.HYDRATION_ATTRIBUTEvariable · Re-export
Canonical data attribute for the versioned envelope of unnamed hydrated refs.
RefSubject.HydrateOptionsinterface · Re-export
Defines the hydrate options state contract.
RefSubject.HydratedRefSubjectinterface · Re-export
Defines the hydrated ref subject state contract.
RefSubject.HydrationAttributeinterface · Re-export
Defines the hydration attribute state contract.
RefSubject.HydrationElementinterface · Re-export
Defines the hydration element state contract.
RefSubject.HydrationRefinterface · Re-export
Defines the hydration ref state contract.
RefSubject.HydrationRefTypeIdvariable · Re-export
Runtime symbol exposing hydration metadata on a hydrated RefSubject.
Hydration types
RefSubject.HydratedRefSubject.Anytype-alias · Re-export
Describes the any type.
RefSubject.HydratedRefSubject.HydrationErrortype-alias · Re-export
Describes the hydration error type.
RefSubject.HydratedRefSubject.HydrationServicestype-alias · Re-export
Describes the hydration services type.
Keyed work
Fx.keyedvariable · Re-export
Efficiently transforms a list of values into a list of Fx streams, using keys to track identity.
This is crucial for performance when rendering lists or managing collections of stateful entities. When the input list changes:
- New keys cause
onValueto be called. - Existing keys have their
RefSubjectupdated with the new value. - Removed keys close the supplied child Scope and clean resources registered
through it; the
onValuerun fiber remains owned by the outer parent Scope.
- New keys cause
Observation policy
RefSubject.CurrentComputedBehaviorvariable · Re-export
Selects whether a computed Fx observes only its current value or also follows later pushes.
RefSubject.slicevariable · Re-export
Limits which pushed versions a RefSubject view observes without changing its state.
Observing failures
Fx.onErrorvariable · Re-export
Runs cleanup after the source reports a failure cause.
Fx.withSpanvariable · Re-export
Traces the whole subscription and each success or failure delivery.
Operator options
Fx.Boundsinterface · Re-export
Defines the bounds for slicing an Fx stream.
Fx.FromStreamOptionstype-alias · Re-export
Effect Stream mapping options used while delivering elements to an
Fxsink.Fx.KeyedOptionsinterface · Re-export
Configuration options for the
keyedcombinator.Fx.ThrottleOptionstype-alias · Re-export
Options for {@link throttle}. A duration-only call is leading-edge (
{ leading: true, trailing: false }).Fx.ToStreamOptionstype-alias · Re-export
Buffering and callback options accepted while adapting an
Fxto an EffectStream.Sink.Boundsinterface · Re-export
Zero-based skip count and maximum take count used by
slice.
Optional channel transformations
Versioned.filterMapvariable · Re-export
Filter-maps a Versioned’s output as both an Fx and Effect; the Effect value becomes
Option(Some when the predicate holds, None otherwise).Versioned.filterMapEffectvariable · Re-export
Filter-maps a Versioned’s output as both an Fx and Effect using an Effect; the Effect value becomes
Option.
Optional queries
RefArray.getIndexvariable · Re-export
Get a value contained a particular index of a RefArray.
RefArray.headvariable · Re-export
Gets the first element of a
RefArrayas aFiltered.RefArray.lastvariable · Re-export
Gets the last element of a
RefArrayas aFiltered.RefChunk.findFirstvariable · Re-export
Find the first value satisfying a predicate.
RefChunk.findLastvariable · Re-export
Find the last value satisfying a predicate.
RefChunk.getIndexvariable · Re-export
Get a value at a particular index of a RefChunk.
RefChunk.headvariable · Re-export
Get the first element of a RefChunk as a Filtered.
RefChunk.lastvariable · Re-export
Get the last element of a RefChunk as a Filtered.
RefGraph.findEdgevariable · Re-export
Find an edge matching a predicate.
RefGraph.findNodevariable · Re-export
Find a node matching a predicate.
RefGraph.getEdgevariable · Re-export
Get an edge’s data.
RefGraph.getNodevariable · Re-export
Get a node’s data.
RefHashMap.findFirstvariable · Re-export
Find the first entry satisfying a predicate.
RefHashMap.getvariable · Re-export
Get the value at a key as a Filtered.
RefHashRing.getvariable · Re-export
Get the node which should handle a given input string as a Filtered. Fails if the ring is empty.
RefIterable.findFirstvariable · Re-export
Find the first value satisfying a predicate.
RefIterable.findLastvariable · Re-export
Find the last value satisfying a predicate.
RefIterable.headvariable · Re-export
Get the first element of a RefIterable as a Filtered.
RefOption.getValuevariable · Re-export
Get the value from the Option as a Filtered (fails if None).
RefRecord.findFirstvariable · Re-export
Find the first entry satisfying a predicate.
RefRecord.getvariable · Re-export
Get the value at a key as a Filtered.
RefRecord.popvariable · Re-export
Pop a value at a key as a Filtered.
RefResult.getFailurevariable · Re-export
Get the failure value from the Result as a Filtered (fails if Success).
RefResult.getSuccessvariable · Re-export
Get the success value from the Result as a Filtered (fails if Failure).
RefSubject.compactvariable · Re-export
Converts a
ComputedorFilteredofOption<A>into aFiltered<A>, filtering outNonevalues.RefSubject.filterMapvariable · Re-export
Filters and transforms a
RefSubject,Computed, orFilteredusing a pure function that returns anOption.RefSubject.filterMapEffectvariable · Re-export
Filters and transforms a
RefSubject,Computed, orFilteredusing anEffectful function that returns anOption.RefSubject.getOrElsevariable · Re-export
Returns a
Computedthat yields the value inside theOption, or the fallback whenNone. Works withComputed<Option<A>>(e.g. fromfromOption/fromNullable) and withFiltered<A>.RefSubject.makeFilteredfunction · Re-export
Builds a Filtered view from the three channels of a Versioned source.
RefTrie.getvariable · Re-export
Get the value at a key as a Filtered.
Output failures
Push.mapErrorvariable · Re-export
Transforms the output (Fx) error channel of a
Pushusing the provided function.Failures (Cause) are mapped via
Cause.map, so only the typed failure (Fail) is transformed; defects and interrupts are preserved unchanged.Mirrors
Effect.mapErroron the Fx side. Cardinality, value order, input callbacks, and output service requirements are unchanged.
Providing services
Fx.Fx.Serviceinterface · Re-export
An
Fxwhose implementation is obtained from an Effect service.Fx.Servicefunction · Re-export
Defines an Effect service whose value is also a directly runnable
Fx.Fx.providevariable · Re-export
Builds a Layer for each subscription and provides it to the entire Fx run.
Fx.provideContextvariable · Re-export
Provides an already-built Effect Context to the entire Fx run.
Fx.provideServicevariable · Re-export
Provides one existing service value to the entire Fx run.
Fx.provideServiceEffectvariable · Re-export
Acquires one service with an Effect before running the Fx.
Publication contracts
Subject.Subjectinterface · Re-export
A multicast boundary that is both an
Fxof its publications and aSinkthat accepts them. Successes and failures are pushed to every subscriber present when that publication begins.
Push construction
Push.makevariable · Re-export
Couples a
Sinkinput with an independentFxoutput.The result forwards each input callback directly to
sinkand delegates every output subscription tofx. It does not connect the two values, change output cardinality or ordering, buffer inputs, or start either side eagerly.
Push services
Push.Push.Classinterface · Re-export
Constructable static type produced by
Push.Service.Push.Push.Serviceinterface · Re-export
The static and Effect service surface returned by
Push.Service.Service lookup supplies the same bidirectional value to
run,onSuccess, andonFailure. TheSelfservice appears in both required-service channels; the installed Push itself has those requirements captured by its Layer.Push.Servicefunction · Re-export
Defines a named Effect service whose value is a
Push.The returned class exposes
onSuccess,onFailure, andrunas Effects that first resolve the service from Context.makecaptures the Sink construction context and combines it with each output subscriber’s context; it does not start the Fx or send an input while building the Layer.
Read-only state
RefSubject.Computedinterface · Re-export
A
Computedis a read-only view of a value that can change over time. It is anFxthat emits the current value and subsequent updates. It is also anEffectthat samples the current value.RefSubject.Filteredinterface · Re-export
A
Filteredis aComputedthat may not always have a value. It is essentially aComputed<Option<A>>with helper methods.
Resource lifetime
Fx.ensuringvariable · Re-export
Runs a finalizer with no typed error after the Fx run ends for any reason.
Fx.onExitvariable · Re-export
Observes the Fx’s final success or failure with an Effect finalizer.
Fx.onInterruptvariable · Re-export
Runs a finalizer when the Fx reports or externally receives interruption.
Running effects
Fx.drainvariable · Re-export
Runs an
Fxstream to completion, discarding all values. Useful when the side effects of the stream are all that matter.Fx.drainLayervariable · Re-export
Runs an
Fxstream as a Layer. The stream is forked in the background when the layer is acquired.Fx.forkvariable · Re-export
Forks the execution of an
Fxinto a background fiber. The stream will run until it completes or the fiber is interrupted.Fx.observevariable · Re-export
Observes the values of an
Fxstream using a callback function. The callback can returnvoidor anEffectwhich will be executed for each value.Fx.observeLayervariable · Re-export
Observes the values of an
Fxstream using a callback function and returns aLayer. The callback can returnvoidor anEffectwhich will be executed for each value.Fx.runForkvariable · Re-export
Runs an
Fxin a new fiber, using the standardEffect.runFork. This is useful for integrating with the top-level Effect runtime.Fx.runPromisevariable · Re-export
Runs an
Fxstream to completion and returns a Promise. Rejects if the stream fails.Fx.runPromiseExitvariable · Re-export
Runs an
Fxstream to completion and returns a Promise of the Exit.
Runtime inspection
Fx.FxTypeIdvariable · Re-export
Runtime symbol carried by every
Fximplementation.Fx.isFxfunction · Re-export
Checks whether a value carries the
FxTypeIdprotocol property.
Selecting inputs
Push.filterInputvariable · Re-export
Keeps successful inputs that satisfy
fand discards the rest.Calling
onSuccessruns the predicate immediately. A match constructs one Sink callback Effect; a non-match immediately returns an empty acknowledgment. Predicate allocation and throws therefore occur before the returned Effect is run. The producer controls call order and concurrency; output is preserved.Push.filterInputEffectvariable · Re-export
Effectfully decides whether each successful input reaches the Sink.
Calling
onSuccess(value)invokesf(value)immediately to construct the predicate Effect; allocation and throws happen before an acknowledgment is returned. Running the acknowledgment later executes that Effect in the caller’s fiber.trueforwards one value,falsenone, and failure sends its Cause to the Sink failure callback. Calls are not serialized; the producer controls order and concurrency. Output behavior is unchanged.Push.filterMapInputvariable · Re-export
Transforms an input and forwards it only when
freturnsSome.Calling
onSuccessevaluatesfimmediately.Some(a)constructs one Sink callback Effect;Noneimmediately returns an empty acknowledgment. Mapping allocation and throws therefore happen before the returned Effect runs. Calls are not serialized, so ordering follows the producer. Output is unchanged.Push.filterMapInputEffectvariable · Re-export
Effectfully transforms an input and forwards only a resulting
Somevalue.Calling
onSuccess(value)invokesf(value)immediately to construct an Effect; allocation and throws happen before an acknowledgment is returned. Running that acknowledgment later executes the constructed Effect in the caller’s fiber.Some(a)produces one Sink callback,Nonenone, and failure sends its full Cause to the Sink failure callback. Concurrent calls are not serialized.Sink.compactfunction · Re-export
Forwards
Somevalues and discardsNonevalues.Sink.filterfunction · Re-export
Filters values before they reach the sink using a predicate function.
Sink.filterEffectvariable · Re-export
Runs an effectful predicate and forwards inputs for which it succeeds with
true.Sink.filterMapfunction · Re-export
Filters and transforms values before they reach the sink using a function that returns an
Option.Sink.filterMapEffectvariable · Re-export
Runs an Effect for each input and forwards its optional successful value.
Selecting outputs
Push.filtervariable · Re-export
Keeps Fx output values that satisfy
f.The upstream Sink invokes the predicate synchronously for each output value, before the returned downstream callback Effect runs. Predicate allocation and throws therefore occur at upstream callback invocation. Matches preserve their relative order; non-matches produce no output. No buffer is added and every input callback is unchanged.
Push.filterEffectvariable · Re-export
Effectfully decides which Fx output values are emitted.
Each upstream value runs one predicate.
trueemits that value,falseemits none, and predicate failures join the output error channel. For a sequential source the predicate is acknowledged before the next delivery, preserving order; the input side is unchanged.Push.filterMapvariable · Re-export
Maps each Fx output and emits only resulting
Somevalues.The upstream Sink evaluates
fsynchronously for each value, before its returned downstream callback Effect runs. Mapping allocation and throws occur at that callback invocation.Some(c)emits exactly onec;Noneemits nothing. Relative order, errors, services, and input behavior are preserved.Push.filterMapEffectvariable · Re-export
Effectfully maps each Fx output and emits only resulting
Somevalues.One mapper Effect runs per upstream value.
Some(c)emits once,Noneemits nothing, and failures join the output error channel. Sequential sources retain order; the input Sink remains unchanged.
Selecting values
Fx.changesWithEffectvariable · Re-export
Drops consecutive elements that are considered equal by an effectful predicate. When the effect returns
true, the element is skipped; whenfalse, it is emitted.This is the effectful variant of
skipRepeatsWith: instead of a pureEquivalence<A>, you supply(prev, next) => Effect<boolean>wheretruemeans “equal” (skip) andfalsemeans “changed” (emit).Fx.compactvariable · Re-export
Compacts an Fx of Options, discarding
Nonevalues and unwrappingSomevalues.Fx.dropAftervariable · Re-export
Drops elements from an Fx after a predicate returns true. The element that satisfies the predicate is included in the output.
Fx.dropUntilvariable · Re-export
Drops elements from an Fx until a predicate returns true. Emits from the first element for which the predicate returns true (including that element) and all following elements.
Fx.dropUntilEffectvariable · Re-export
Drops elements from an Fx until an effectful predicate returns true. Emits from the first element for which the predicate effect succeeds with true (including that element) and all following elements.
Fx.dropWhilevariable · Re-export
Alias of
skipWhilefor Effect parity (dropWhilenaming).Fx.dropWhileEffectvariable · Re-export
Alias of
skipWhileEffectfor Effect parity (dropWhileEffectnaming).Fx.filtervariable · Re-export
Filters elements of an Fx using a predicate function.
Fx.filterEffectvariable · Re-export
Filters elements of an Fx using an effectful predicate function.
Fx.filterMapvariable · Re-export
Maps and filters elements of an Fx in a single operation.
Fx.filterMapEffectvariable · Re-export
Maps and filters elements of an Fx using an effectful function.
Fx.skipvariable · Re-export
Skips the first
nelements of an Fx.Fx.skipEffectvariable · Re-export
Skips the first
nelements wherenis produced by an Effect.Fx.skipRepeatsvariable · Re-export
Drops elements that are equal to the previous element using standard equality.
Fx.skipRepeatsWithvariable · Re-export
Drops elements that are equal to the previous element using a custom equivalence function.
Fx.skipWhilevariable · Re-export
Skips elements from an Fx while a predicate returns true. Emits from the first element for which the predicate returns false (including that element) and all following elements.
Fx.skipWhileEffectvariable · Re-export
Skips elements from an Fx while an effectful predicate returns true. Emits from the first element for which the predicate effect succeeds with false (including that element) and all following elements.
Fx.slicevariable · Re-export
Slices an Fx by skipping a number of elements and then taking a number of elements.
Fx.sliceEffectvariable · Re-export
Slices an Fx with bounds produced by an Effect.
Fx.takevariable · Re-export
Takes the first
nelements from an Fx and then completes.Fx.takeEffectvariable · Re-export
Takes the first
nelements wherenis produced by an Effect.Fx.takeUntilvariable · Re-export
Takes elements from an Fx until a predicate returns true. The element that satisfies the predicate is not included in the output.
Fx.takeUntilEffectvariable · Re-export
Takes elements from an Fx until an effectful predicate returns true. The element that satisfies the predicate is not included in the output.
Fx.takeWhilevariable · Re-export
Takes elements from an Fx while a predicate returns true. Stops at the first element for which the predicate returns false; that element is not included.
Fx.takeWhileEffectvariable · Re-export
Takes elements from an Fx while an effectful predicate returns true. Stops at the first element for which the predicate effect succeeds with false; that element is not included.
Services
RefSubject.RefSubject.Classinterface · Re-export
Defines the class state contract.
RefSubject.RefSubject.Serviceinterface · Re-export
Defines the service state contract.
RefSubject.Servicefunction · Re-export
Creates a Context-backed RefSubject service facade and Layer constructors.
RefSubject.computedFromServicefunction · Re-export
Lifts an Effect-provided Computed into a Computed facade.
RefSubject.filteredFromServicefunction · Re-export
Defers retrieval of a Filtered value from Effect Context while preserving Filtered behavior.
Versioned.Servicefunction · Re-export
Creates a Context-backed Versioned service facade and Layer constructor.
Versioned.Versioned.Classinterface · Re-export
Defines the class state contract.
Versioned.Versioned.Serviceinterface · Re-export
Defines the service state contract.
Versioned.providevariable · Re-export
Provides context to a Versioned value.
Sharing sources
Subject.Shareclass · Re-export
The concrete lazy
Fxreturned byshare.Subject.holdfunction · Re-export
Shares an
Fxand immediately replays its latest success or failure to each new subscriber.Subject.multicastfunction · Re-export
Multicasts an
Fxwithout replaying values that arrived before a subscriber joined.Subject.replayvariable · Re-export
Shares an
Fxand replays up to the lastcapacitysuccesses or failures to new subscribers.Subject.sharefunction · Re-export
Shares one active execution of an
Fxamong subscribers through the suppliedSubject.
Sink construction
Sink.makefunction · Re-export
Creates a Sink from success and failure callbacks.
Sink services
Sink.Servicefunction · Re-export
Defines a class-shaped Effect Context service for a Sink.
Sink.Sink.Classinterface · Re-export
Constructor-shaped Context service returned by
Sink.Service.Sink.Sink.Serviceinterface · Re-export
Describes a Sink available through an Effect Context service.
Source adapters
RefSubject.fromEffectfunction · Re-export
Creates a
RefSubjectfrom anEffect.RefSubject.fromFxfunction · Re-export
Creates a
RefSubjectfrom anFx, tracking the latest emitted value.RefSubject.fromNullablefunction · Re-export
Creates Option-valued RefSubject state from a nullable input.
RefSubject.fromOptionfunction · Re-export
Creates a
RefSubjectfrom anOptionvalue.RefSubject.fromStreamfunction · Re-export
Creates a RefSubject that tracks the latest value emitted by an Effect Stream.
State composition
RefSubject.structfunction · Re-export
Combines multiple
RefSubject,Computed, orFilteredinstances into a single struct.RefSubject.tuplefunction · Re-export
Combines multiple
RefSubject,Computed, orFilteredinstances into a single tuple.Versioned.structfunction · Re-export
Combines multiple Versioned values into a single struct.
Versioned.tuplefunction · Re-export
Combines multiple Versioned values into a single tuple.
State models
RefArray.RefArrayinterface · Re-export
A RefArray is a RefSubject that is specialized over an array of values.
RefBigDecimal.RefBigDecimalinterface · Re-export
A RefBigDecimal is a RefSubject specialized over a BigDecimal value.
RefBigInt.RefBigIntinterface · Re-export
A RefBigInt is a RefSubject specialized over a BigInt value.
RefBoolean.RefBooleaninterface · Re-export
A RefBoolean is a RefSubject specialized over a boolean value.
RefCause.RefCauseinterface · Re-export
A RefCause is a RefSubject specialized over a Cause value.
RefChunk.RefChunkinterface · Re-export
A RefChunk is a RefSubject specialized over a Chunk of values.
RefDateTime.RefDateTimeinterface · Re-export
A RefDateTime is a RefSubject specialized over a DateTime value.
RefDuration.RefDurationinterface · Re-export
A RefDuration is a RefSubject specialized over a Duration value.
RefGraph.RefGraphinterface · Re-export
A RefGraph is a RefSubject specialized over a Graph.
RefHashMap.RefHashMapinterface · Re-export
A RefHashMap is a RefSubject specialized over a HashMap.
RefHashRing.RefHashRinginterface · Re-export
A RefHashRing is a RefSubject specialized over a HashRing.
RefHashSet.RefHashSetinterface · Re-export
A RefHashSet is a RefSubject specialized over a HashSet.
RefIterable.RefIterableinterface · Re-export
A RefIterable is a RefSubject specialized over an Iterable of values.
RefOption.RefOptioninterface · Re-export
A RefOption is a RefSubject specialized over an Option value.
RefRecord.RefRecordinterface · Re-export
A RefRecord is a RefSubject specialized over a Record.
RefResult.RefResultinterface · Re-export
A RefResult is a RefSubject specialized over a Result value.
RefString.RefStringinterface · Re-export
A RefString is a RefSubject specialized over a string value.
RefStruct.RefStructinterface · Re-export
A RefStruct is a RefSubject specialized over a struct value.
RefTrie.RefTrieinterface · Re-export
A RefTrie is a RefSubject specialized over a Trie.
RefTuple.RefTupleinterface · Re-export
A RefTuple is a RefSubject specialized over a tuple value.
State predicates
RefArray.isEmptyvariable · Re-export
Check to see if a RefArray is empty.
RefArray.isNonEmptyvariable · Re-export
Check to see if a RefArray is non-empty.
RefBigDecimal.isGreaterThanvariable · Re-export
Check if the current state of a RefBigDecimal is greater than a BigDecimal.
RefBigDecimal.isIntegervariable · Re-export
Check if the current state of a RefBigDecimal is an integer.
RefBigDecimal.isLessThanvariable · Re-export
Check if the current state of a RefBigDecimal is less than a BigDecimal.
RefBigDecimal.isNegativevariable · Re-export
Check if the current state of a RefBigDecimal is negative.
RefBigDecimal.isPositivevariable · Re-export
Check if the current state of a RefBigDecimal is positive.
RefBigDecimal.isZerovariable · Re-export
Check if the current state of a RefBigDecimal is zero.
RefBigInt.isGreaterThanvariable · Re-export
Check if the current state of a RefBigInt is greater than a BigInt.
RefBigInt.isLessThanvariable · Re-export
Check if the current state of a RefBigInt is less than a BigInt.
RefBigInt.isNegativevariable · Re-export
Check if the current state of a RefBigInt is negative.
RefBigInt.isPositivevariable · Re-export
Check if the current state of a RefBigInt is positive.
RefBigInt.isZerovariable · Re-export
Check if the current state of a RefBigInt is zero.
RefBoolean.isFalsevariable · Re-export
Check if the current state of a RefBoolean is false.
RefBoolean.isTruevariable · Re-export
Check if the current state of a RefBoolean is true.
RefCause.hasDiesvariable · Re-export
Check if the current state of a RefCause has a Die.
RefCause.hasFailsvariable · Re-export
Check if the current state of a RefCause has a Fail.
RefCause.hasInterruptsvariable · Re-export
Check if the current state of a RefCause has an Interrupt.
RefCause.isEmptyvariable · Re-export
Check if the current state of a RefCause is empty.
RefChunk.containsvariable · Re-export
Check if a RefChunk contains a value.
RefChunk.everyvariable · Re-export
Check if all values satisfy a predicate.
RefChunk.isEmptyvariable · Re-export
Check if a RefChunk is empty.
RefChunk.isNonEmptyvariable · Re-export
Check if a RefChunk is non-empty.
RefChunk.somevariable · Re-export
Check if any value satisfies a predicate.
RefDateTime.isAftervariable · Re-export
Check if the current state of a RefDateTime is after another DateTime.
RefDateTime.isBeforevariable · Re-export
Check if the current state of a RefDateTime is before another DateTime.
RefDateTime.isEqualvariable · Re-export
Check if the current state of a RefDateTime equals another DateTime.
RefDuration.isGreaterThanvariable · Re-export
Check if the current state of a RefDuration is greater than a Duration.
RefDuration.isLessThanvariable · Re-export
Check if the current state of a RefDuration is less than a Duration.
RefDuration.isZerovariable · Re-export
Check if the current state of a RefDuration is zero.
RefGraph.hasEdgevariable · Re-export
Check if an edge exists.
RefGraph.hasNodevariable · Re-export
Check if a node exists.
RefGraph.isAcyclicvariable · Re-export
Check if the graph is acyclic.
RefGraph.isBipartitevariable · Re-export
Check if the graph is bipartite (undirected only).
RefHashMap.everyvariable · Re-export
Check if all entries satisfy a predicate.
RefHashMap.hasvariable · Re-export
Check if a key exists in the RefHashMap.
RefHashMap.isEmptyvariable · Re-export
Check if the RefHashMap is empty.
RefHashMap.isNonEmptyvariable · Re-export
Check if the RefHashMap is non-empty.
RefHashMap.somevariable · Re-export
Check if any entry satisfies a predicate.
RefHashRing.hasvariable · Re-export
Check if a node exists in the HashRing.
RefHashRing.isEmptyvariable · Re-export
Check if the HashRing is empty.
RefHashSet.everyvariable · Re-export
Check if all values satisfy a predicate.
RefHashSet.hasvariable · Re-export
Check if a value exists in the RefHashSet.
RefHashSet.isEmptyvariable · Re-export
Check if the RefHashSet is empty.
RefHashSet.isNonEmptyvariable · Re-export
Check if the RefHashSet is non-empty.
RefHashSet.isSubsetvariable · Re-export
Check if this set is a subset of another.
RefHashSet.somevariable · Re-export
Check if any value satisfies a predicate.
RefIterable.containsvariable · Re-export
Check if a RefIterable contains a value.
RefIterable.isEmptyvariable · Re-export
Check if a RefIterable is empty.
RefIterable.somevariable · Re-export
Check if any value satisfies a predicate.
RefOption.containsvariable · Re-export
Check if the current state of a RefOption contains a value.
RefOption.existsvariable · Re-export
Check if the value inside the Option satisfies a predicate.
RefOption.isNonevariable · Re-export
Check if the current state of a RefOption is None.
RefOption.isSomevariable · Re-export
Check if the current state of a RefOption is Some.
RefRecord.everyvariable · Re-export
Check if all entries satisfy a predicate.
RefRecord.hasvariable · Re-export
Check if a key exists in the Record.
RefRecord.isEmptyvariable · Re-export
Check if the Record is empty.
RefRecord.isNonEmptyvariable · Re-export
Check if the Record is non-empty.
RefRecord.somevariable · Re-export
Check if any entry satisfies a predicate.
RefResult.isFailurevariable · Re-export
Check if the current state of a RefResult is Failure.
RefResult.isSuccessvariable · Re-export
Check if the current state of a RefResult is Success.
RefString.isEmptyvariable · Re-export
Check if the current state of a RefString is empty.
RefString.isNonEmptyvariable · Re-export
Check if the current state of a RefString is non-empty.
RefStruct.hasvariable · Re-export
Check if the current state of a RefStruct has a property.
RefTrie.hasvariable · Re-export
Check if a key exists in the Trie.
RefTrie.isEmptyvariable · Re-export
Check if the Trie is empty.
RefTrie.isNonEmptyvariable · Re-export
Check if the Trie is non-empty.
State protocol
Versioned.Versionedinterface · Re-export
A Versioned value is a value that changes over time, and each change is associated with a version number. It combines the capabilities of an
Fx(to observe changes) and anEffect(to get the current value).
State updates
RefArray.appendvariable · Re-export
Append a value to the current state of a RefArray.
RefArray.appendAllvariable · Re-export
Append an iterable of values to the current state of a RefArray.
RefArray.dedupeWithvariable · Re-export
Remove any duplicate values from a RefArray.
RefArray.dropvariable · Re-export
Drop the first
nvalues from a RefArray.RefArray.dropRightvariable · Re-export
Drop the last
nvalues from a RefArray.RefArray.dropWhilevariable · Re-export
Drop values from a RefArray while a predicate is true.
RefArray.insertAtvariable · Re-export
Insert a value at a particular index of a RefArray.
RefArray.mapvariable · Re-export
Map (Endomorphic) the values of a RefArray.
RefArray.modifyAtvariable · Re-export
Modify the value at a particular index of a RefArray.
RefArray.prependvariable · Re-export
Prepend a value to the current state of a RefArray.
RefArray.prependAllvariable · Re-export
Prepend an iterable of values to the current state of a RefArray.
RefArray.replaceAtvariable · Re-export
Replace a value at a particular index of a RefArray.
RefArray.rotatevariable · Re-export
Rotate the values of a RefArray by
nplaces. Helpful for things like carousels.RefArray.sortByvariable · Re-export
Sort the values of a RefArray using a provided Order.
RefArray.takevariable · Re-export
Take the first
nvalues from a RefArray.RefArray.takeRightvariable · Re-export
Take the last
nvalues from a RefArray.RefArray.takeWhilevariable · Re-export
Take values from a RefArray while a predicate is true.
RefBoolean.setFalsevariable · Re-export
Set the current state of a RefBoolean to false.
RefBoolean.setTruevariable · Re-export
Set the current state of a RefBoolean to true.
RefBoolean.togglevariable · Re-export
Toggle the current state of a RefBoolean.
RefCause.setDievariable · Re-export
Set the current state of a RefCause to a Die cause.
RefCause.setFailvariable · Re-export
Set the current state of a RefCause to a Fail cause.
RefCause.setInterruptvariable · Re-export
Set the current state of a RefCause to an Interrupt cause.
RefChunk.appendvariable · Re-export
Append a value to the current state of a RefChunk.
RefChunk.appendAllvariable · Re-export
Append an iterable of values to the current state of a RefChunk.
RefChunk.dedupevariable · Re-export
Remove duplicate values from a RefChunk.
RefChunk.dedupeAdjacentvariable · Re-export
Remove adjacent duplicate values from a RefChunk.
RefChunk.dropvariable · Re-export
Drop the first
nvalues from a RefChunk.RefChunk.dropRightvariable · Re-export
Drop the last
nvalues from a RefChunk.RefChunk.dropWhilevariable · Re-export
Drop values from a RefChunk while a predicate is true.
RefChunk.filtervariable · Re-export
Filter the values of a RefChunk (mutating).
RefChunk.mapvariable · Re-export
Map (Endomorphic) the values of a RefChunk.
RefChunk.modifyAtvariable · Re-export
Modify the value at a particular index of a RefChunk.
RefChunk.prependvariable · Re-export
Prepend a value to the current state of a RefChunk.
RefChunk.prependAllvariable · Re-export
Prepend an iterable of values to the current state of a RefChunk.
RefChunk.removevariable · Re-export
Remove a value at a particular index of a RefChunk.
RefChunk.replaceAtvariable · Re-export
Replace a value at a particular index of a RefChunk.
RefChunk.reversevariable · Re-export
Reverse the values of a RefChunk.
RefChunk.sortvariable · Re-export
Sort the values of a RefChunk using a provided Order.
RefChunk.takevariable · Re-export
Take the first
nvalues from a RefChunk.RefChunk.takeRightvariable · Re-export
Take the last
nvalues from a RefChunk.RefChunk.takeWhilevariable · Re-export
Take values from a RefChunk while a predicate is true.
RefGraph.addEdgevariable · Re-export
Add an edge to the graph.
RefGraph.addNodevariable · Re-export
Add a node to the graph.
RefGraph.filterEdgesvariable · Re-export
Filter edges.
RefGraph.filterNodesvariable · Re-export
Filter nodes.
RefGraph.mapEdgesvariable · Re-export
Map all edge data.
RefGraph.mapNodesvariable · Re-export
Map all node data.
RefGraph.removeEdgevariable · Re-export
Remove an edge from the graph.
RefGraph.removeNodevariable · Re-export
Remove a node from the graph.
RefGraph.reversevariable · Re-export
Reverse all edge directions.
RefGraph.updateEdgevariable · Re-export
Update an edge’s data.
RefGraph.updateNodevariable · Re-export
Update a node’s data.
RefHashMap.clearvariable · Re-export
Clear all entries from the RefHashMap.
RefHashMap.filtervariable · Re-export
Filter entries in place.
RefHashMap.mapvariable · Re-export
Map values in place (endomorphic).
RefHashMap.modifyvariable · Re-export
Modify the value at a key if it exists.
RefHashMap.modifyAtvariable · Re-export
Modify the value at a key using an Option-based update function.
RefHashMap.removevariable · Re-export
Remove a key from the RefHashMap.
RefHashMap.removeManyvariable · Re-export
Remove multiple keys from the RefHashMap.
RefHashMap.setvariable · Re-export
Set a key-value pair in the RefHashMap.
RefHashMap.setManyvariable · Re-export
Set multiple key-value pairs in the RefHashMap.
RefHashMap.unionvariable · Re-export
Merge another HashMap into this one.
RefHashRing.addvariable · Re-export
Add a node to the HashRing.
RefHashRing.addManyvariable · Re-export
Add multiple nodes to the HashRing.
RefHashRing.removevariable · Re-export
Remove a node from the HashRing.
RefHashSet.addvariable · Re-export
Add a value to the RefHashSet.
RefHashSet.clearvariable · Re-export
Clear all values from the RefHashSet.
RefHashSet.differencevariable · Re-export
Compute the difference with another HashSet.
RefHashSet.filtervariable · Re-export
Filter values in place.
RefHashSet.intersectionvariable · Re-export
Compute the intersection with another HashSet.
RefHashSet.mapvariable · Re-export
Map values in place (endomorphic).
RefHashSet.removevariable · Re-export
Remove a value from the RefHashSet.
RefHashSet.unionvariable · Re-export
Compute the union with another HashSet.
RefIterable.appendvariable · Re-export
Append a value to the current state of a RefIterable.
RefIterable.appendAllvariable · Re-export
Append an iterable of values to the current state of a RefIterable.
RefIterable.dedupeAdjacentvariable · Re-export
Remove adjacent duplicate values from a RefIterable.
RefIterable.dropvariable · Re-export
Drop the first
nvalues from a RefIterable.RefIterable.filtervariable · Re-export
Filter the values of a RefIterable (mutating).
RefIterable.filterMapvariable · Re-export
Filter and map values in place.
RefIterable.flatMapvariable · Re-export
FlatMap (endomorphic).
RefIterable.getSomesvariable · Re-export
Extract Some values from Option iterable.
RefIterable.interspersevariable · Re-export
Intersperse a separator between elements.
RefIterable.mapvariable · Re-export
Map (Endomorphic) the values of a RefIterable.
RefIterable.prependvariable · Re-export
Prepend a value to the current state of a RefIterable.
RefIterable.prependAllvariable · Re-export
Prepend an iterable of values to the current state of a RefIterable.
RefIterable.repeatvariable · Re-export
Repeat the iterable n times.
RefIterable.takevariable · Re-export
Take the first
nvalues from a RefIterable.RefIterable.takeWhilevariable · Re-export
Take values from a RefIterable while a predicate is true.
RefOption.setNonevariable · Re-export
Set the current state of a RefOption to None.
RefOption.setSomevariable · Re-export
Set the current state of a RefOption to Some(value).
RefRecord.clearvariable · Re-export
Clear all entries from the Record.
RefRecord.differencevariable · Re-export
Difference with another record.
RefRecord.filtervariable · Re-export
Filter entries in place.
RefRecord.intersectionvariable · Re-export
Intersection with another record.
RefRecord.mapvariable · Re-export
Map values in place (endomorphic).
RefRecord.modifyvariable · Re-export
Modify the value at a key if it exists.
RefRecord.removevariable · Re-export
Remove a key from the Record.
RefRecord.replacevariable · Re-export
Replace the value at a key if it exists.
RefRecord.setvariable · Re-export
Set a key-value pair in the Record.
RefRecord.unionvariable · Re-export
Union with another record.
RefResult.setFailurevariable · Re-export
Set the current state of a RefResult to Failure(error).
RefResult.setSuccessvariable · Re-export
Set the current state of a RefResult to Success(value).
RefStruct.mergevariable · Re-export
Merge another struct into the current state of a RefStruct.
RefStruct.setvariable · Re-export
Set a property value in the current state of a RefStruct.
RefStruct.updatevariable · Re-export
Update a property value in the current state of a RefStruct using a function.
RefSubject.decrementfunction · Re-export
Decrements a numeric
RefSubjectby 1.RefSubject.deletefunction · Re-export
Resets a
RefSubjectto its initial value, returning the previous value if it existed.RefSubject.incrementfunction · Re-export
Increments a numeric
RefSubjectby 1.RefSubject.resetfunction · Re-export
Resets a
RefSubjectto its initial value, returning the previous value if it existed.RefSubject.setvariable · Re-export
Sets the value of a
RefSubject.RefSubject.updatevariable · Re-export
Updates a
RefSubjectusing a pure function.RefSubject.updateEffectvariable · Re-export
Updates a
RefSubjectusing anEffectful function.RefTrie.clearvariable · Re-export
Clear all entries from the Trie.
RefTrie.filtervariable · Re-export
Filter entries into a read-only derived trie.
RefTrie.filterMapvariable · Re-export
Filter and map entries into a read-only derived trie.
RefTrie.insertvariable · Re-export
Insert a key-value pair into the Trie.
RefTrie.insertManyvariable · Re-export
Insert multiple key-value pairs into the Trie.
RefTrie.mapvariable · Re-export
Map values into a read-only derived trie.
RefTrie.modifyvariable · Re-export
Modify the value at a key if it exists.
RefTrie.removevariable · Re-export
Remove a key from the Trie.
RefTrie.removeManyvariable · Re-export
Remove multiple keys from the Trie.
RefTuple.setAtvariable · Re-export
Set the value at a specific index in the current state of a RefTuple.
RefTuple.updateAtvariable · Re-export
Update the value at a specific index in the current state of a RefTuple using a function.
Stateful delivery
Sink.Sink.WithStateinterface · Re-export
An early-exit sink with a mutable Effect
Reffor consumer-local state.Sink.Sink.WithStateSemaphoreinterface · Re-export
An early-exit sink with serialized effectful access to consumer-local state.
Sink.filterMapLoopvariable · Re-export
Threads pure state through successes and optionally forwards a derived value.
Sink.filterMapLoopEffectvariable · Re-export
Threads state through an effectful success transition and optionally forwards its value.
Sink.loopvariable · Re-export
Threads pure state through successful inputs and forwards one derived value per input.
Sink.loopEffectvariable · Re-export
Threads state through an effectful success transformation and forwards one value on success.
Sink.withStatefunction · Re-export
Runs a callback with an early-exit sink and a private Effect
Refinitialized tostate.Sink.withStateSemaphorefunction · Re-export
Runs a callback with private state whose effectful reads and writes are serialized.
Stateful failure handling
Sink.filterMapLoopCausevariable · Re-export
Threads pure state through failures and optionally forwards a transformed cause.
Sink.filterMapLoopCauseEffectfunction · Re-export
Threads state through an effectful failure transition and optionally forwards a cause.
Sink.loopCausevariable · Re-export
Threads pure state through failure causes and forwards one transformed cause per failure.
Sink.loopCauseEffectvariable · Re-export
Threads state through an effectful failure transformation.
Stateful outputs
Push.mapAccumvariable · Re-export
Maps over the output (Fx) side of a
Pushwith an accumulator: for each emitted valueb, appliesf(state, b)to get[nextState, emitted]and emits the second element. The first element is the initial state; subsequent states are updated by each step. It emits exactly oneCper upstream value, in order. Accumulator state is private to each output subscription; the input Sink is unchanged.Push.mapAccumEffectvariable · Re-export
Maps over the output (Fx) side of a
Pushwith an effectful accumulator: for each emitted valueb, runsf(state, b)to get[nextState, emitted]and emits the second element. The adapter does not serialize callbacks. CallingonSuccessinvokesfimmediately with the current seed and constructs its Effect; overlapping calls can therefore observe the same seed. Successful completion commits the returned seed and emits in completion order, so later completion may overwrite newer state. Reducer failure is sent to the output Sink, emits nothing, restores that call’s previous seed, and completes normally so a continuing producer can send later values. The input Sink is unchanged.
Stateful transforms
Fx.filterMapLoopvariable · Re-export
Loops over an Fx with an accumulator, producing an optional new value for each element. If the function returns
None, the element is filtered out.Fx.filterMapLoopCausevariable · Re-export
Loops over the failure causes of an Fx with an accumulator, potentially transforming or filtering them. This allows for complex error handling logic that maintains state across failures.
Fx.filterMapLoopCauseEffectvariable · Re-export
Effectfully loops over the failure causes of an Fx with an accumulator.
Fx.filterMapLoopEffectvariable · Re-export
Effectfully loops over an Fx with an accumulator, producing an optional new value.
Fx.groupedvariable · Re-export
Partitions the stream into non-empty arrays of size
n. The final array may be smaller if there are leftover elements. The size must be a positive safe integer. A group can retain up tonvalues, so callers own the memory policy for valid sizes. Invalid sizes fail withCause.IllegalArgumentError.Matches Effect
Stream.grouped.Fx.loopvariable · Re-export
Loops over an Fx with an accumulator, producing a new value for each element and updating the accumulator.
Fx.loopCausevariable · Re-export
Loops over the failure causes of an Fx with an accumulator.
Fx.loopCauseEffectvariable · Re-export
Effectfully loops over the failure causes of an Fx with an accumulator.
Fx.loopEffectvariable · Re-export
Effectfully loops over an Fx with an accumulator, producing a new value for each element.
Fx.pairwisevariable · Re-export
Emits consecutive pairs
[previous, current]. The first value is not emitted until a second value arrives.Equivalent to RxJS
pairwiseand EffectStream.sliding(2)for pairs.Fx.scanvariable · Re-export
Scans the stream with a pure function, emitting the accumulated state after each element. Emits the initial value first, then for each input
aemitsf(state, a)and updates state.Semantics align with Effect Stream’s
scan: output isinitial,f(initial, a1),f(..., a2), …Fx.scanEffectvariable · Re-export
Scans the stream with an effectful function, emitting the accumulated state after each element. Emits the initial value first, then for each input
arunsf(state, a)and emits the resulting state.
Stopping delivery
Sink.Sink.WithEarlyExitinterface · Re-export
A sink that can ask its producer callback to stop early.
Sink.dropAftervariable · Re-export
Runs a producer callback until the first matching value has been forwarded.
Sink.slicevariable · Re-export
Runs a producer callback through a bounded view of a sink.
Sink.withEarlyExitfunction · Re-export
Runs a producer-style callback with a sink that can complete the surrounding Effect early.
Stream interop
Fx.fromStreamvariable · Re-export
Adapts an Effect
Streamto a push-basedFx.Fx.toStreamvariable · Re-export
Adapts a push-based
Fxto an EffectStream.
Subject construction
Subject.makefunction · Re-export
Acquires a
Subjectwhose subscribers and replay state are released with the currentScope.Subject.unsafeMakefunction · Re-export
Immediately allocates a
Subjectwith the requested replay capacity and manual ownership.
Subject services
Subject.Servicefunction · Re-export
Defines an Effect context service that is simultaneously a
Subject,Fx, andSinkfacade.Subject.Subject.Classinterface · Re-export
A constructible service facade whose static side is also the contextual
Subject.Subject.Subject.Serviceinterface · Re-export
The service-shaped form of a
Subjectcreated bySubject.Service.
Time and rate
Fx.atvariable · Re-export
Creates an Fx that emits a single value after a specified delay.
Fx.debouncevariable · Re-export
Emits a value only after no newer source value arrives for
duration.Fx.delayvariable · Re-export
Sleeps for
durationbefore forwarding each successful source delivery.Fx.duringfunction · Re-export
Forwards
eventsonly between a start signal and that signal’s first stop event.Fx.fromSchedulevariable · Re-export
Creates an Fx that emits values according to a Schedule. The Fx emits
voideach time the schedule fires.Fx.groupedWithinvariable · Re-export
Partitions the stream into arrays, emitting when
nis reached ordurationelapses after the first element of the current group. The size must be a positive safe integer. A group can retain up tonvalues, so callers own the memory policy for valid sizes. Invalid sizes fail withCause.IllegalArgumentError.Matches Effect
Stream.groupedWithin.Fx.periodicvariable · Re-export
Creates an Fx that emits a
voidvalue periodically.Fx.repeatvariable · Re-export
Repeats the entire stream according to
scheduleafter each successful completion. Failures are not repeated.Schedule.recurs(n)runs the streamn + 1times (the original plusnrepeats), matching EffectStream.repeat.Fx.samplevariable · Re-export
Emits the latest source value whenever
sampleremits. Source values that arrive between sampler ticks are not forwarded until the next tick.Completion: Completes when the source completes. Errors: The first failure from either stream fails the result.
Fx.sincevariable · Re-export
Drops
eventsuntilsignalemits, then forwards the rest.Fx.throttlevariable · Re-export
Limits emissions to configured leading and trailing edges of fixed windows.
Pass
{ duration, leading, trailing }for trailing or both-edge behavior. A duration alone defaults to{ leading: true, trailing: false }.Fx.timeoutvariable · Re-export
Completes the stream if it does not produce a value (or complete) within
durationof the previous event. Matches EffectStream.timeout.The timeout is reset after each emission. An infinite duration is a no-op; a zero duration completes immediately.
Fx.timeoutTovariable · Re-export
Switches to
fallbackif the source does not produce a value withindurationof the previous event. Matches EffectStream.timeoutOrElseand RxJStimeoutTo.Fx.untilvariable · Re-export
Forwards
eventsuntilsignalemits, then interruptsevents.
Transactions
RefSubject.GetSetDeleteinterface · Re-export
Interface for basic RefSubject operations: get, set, delete.
RefSubject.modifyvariable · Re-export
Modifies a
RefSubjectusing a pure function that returns both a result and a new value.RefSubject.modifyEffectvariable · Re-export
Modifies a
RefSubjectusing anEffectful function that returns both a result and a new value.RefSubject.runUpdatesvariable · Re-export
Runs an effect that can modify a
RefSubjecttransactionally, with optional interrupt handling.
Transforming inputs
Push.mapInputvariable · Re-export
Synchronously transforms each successful input before sending it to the Sink.
One input maps to exactly one downstream input. Calling
onSuccessevaluatesfimmediately, before the returned downstream Effect is run; allocation and thrown exceptions therefore occur at callback invocation (and become defects only when that invocation itself occurs inside Effect evaluation). The Sink callback Effect remains the acknowledgment. Calls are not serialized; execution order and concurrency follow the producer. The Fx output is unchanged.Push.mapInputEffectvariable · Re-export
Effectfully transforms each successful input before sending it to the Sink.
Calling
onSuccess(value)invokesf(value)immediately to construct an Effect. Allocation and thrown exceptions therefore occur before an acknowledgment Effect is returned. Running that returned Effect later executes the constructed Effect in the caller’s fiber. On success its singleAreaches the Sink; typed failure, defect, or interruption sends its full Cause to the Sink failure callback. Calls are not serialized, so the producer controls order and concurrency. Output values and order are unchanged.Sink.mapfunction · Re-export
Transforms values before they reach the sink using a pure function.
Sink.mapEffectvariable · Re-export
Runs an Effect for each input and forwards its successful value to the sink.
Sink.mapInputvariable · Re-export
Alias for
map, named for the input-side direction of the transformation.Sink.mapInputEffectvariable · Re-export
Alias for
mapEffect, named for the input-side direction of the effectful transformation.Sink.tapEffectvariable · Re-export
Runs an effectful observation before forwarding each successful input unchanged.
Transforming outputs
Push.mapvariable · Re-export
Synchronously transforms every value emitted by the Fx output side.
It emits exactly one
Cfor every upstreamB, preserving order and the complete input Sink. The mapping does not buffer or introduce concurrency.Push.mapBothvariable · Re-export
Transforms both the output (Fx) success and error channels of a
Pushusing the provided options.Mirrors
Effect.mapBothon the Fx side:onSuccessmaps every emitted value one-to-one andonFailuremaps typed failures viaCause.map; defects and interrupts are preserved. Ordering, services, and the input side are unchanged.Push.mapEffectvariable · Re-export
Effectfully transforms each Fx output value.
The mapper runs once per upstream value and emits one result on success, in upstream order for a sequential source. Its typed failures join
E2; its required services joinR2. The input side is unchanged.
Transforming values
Fx.asvariable · Re-export
Replaces all emitted values from the Fx with the provided value
b.Fx.mapvariable · Re-export
Transforms the elements of an Fx using a provided function.
Fx.mapEffectvariable · Re-export
Transforms the elements of an Fx using a provided Effectful function.
Fx.tapvariable · Re-export
Performs an effect for each element of the Fx, without changing the elements.
Type contracts
Fx.Errortype-alias · Re-export
Alias of
Fx.Errorfor extracting anFxerror channel.Fx.FlatMapEffectLiketype-alias · Re-export
Describes a dual flattening operator whose callback returns an Effect.
Fx.FlatMapLiketype-alias · Re-export
Describes a dual flattening operator whose callback returns an Fx.
Fx.Fxinterface · Re-export
Fxis a reactive stream of values that supports concurrency, error handling, and context management, fully integrated with the Effect ecosystem.Conceptually, an
Fx<A, E, R>is a push-based stream that:- Emits values of type
A - Can fail with an error of type
E - Requires a context/environment of type
R
Unlike a standard
Effectwhich produces a single value,Fxcan produce 0, 1, or many values over time. It is similar to RxJS Observables or AsyncIterables, but built on top of Effect’s fiber-based concurrency model.- Emits values of type
Fx.Fx.Errortype-alias · Re-export
Extracts the typed error from an
Fx.Fx.Fx.Servicestype-alias · Re-export
Extracts the services required to run an
Fx.Fx.Fx.Successtype-alias · Re-export
Extracts the emitted value type from an
Fx.Fx.Servicestype-alias · Re-export
Alias of
Fx.Servicesfor extracting anFxservice channel.Fx.Successtype-alias · Re-export
Alias of
Fx.Successfor extracting anFxvalue channel.Fx.fn.Gentype-alias · Re-export
Contract for functions whose body yields Effects and returns an
Fx.Fx.fn.NonGentype-alias · Re-export
Contract for functions whose body returns an
Fxdirectly.Push.Push.Anytype-alias · Re-export
Matches any
Pushwhen its six channel types are intentionally unknown.Sink.Errortype-alias · Re-export
Alias of
Sink.Errorfor direct imports.Sink.Servicestype-alias · Re-export
Alias of
Sink.Servicesfor direct imports.Sink.Sink.Anytype-alias · Re-export
Matches any
Sinkwhen its channels do not need to be preserved.Sink.Sink.Errortype-alias · Re-export
Extracts the typed error carried by causes consumed by a
Sink.Sink.Sink.Servicestype-alias · Re-export
Extracts the Effect services required by a
Sink’s callbacks.Sink.Sink.Successtype-alias · Re-export
Extracts the successful input type consumed by a
Sink.Sink.Successtype-alias · Re-export
Alias of
Sink.Successfor direct imports.
Type guards
RefSubject.isComputedfunction · Re-export
Tests whether a value carries the public Computed TypeId.
RefSubject.isHydrationReffunction · Re-export
Tests whether a value carries callable hydration metadata.
RefSubject.isRefSubjectfunction · Re-export
Checks if a value is a
RefSubject.
Type identity
RefSubject.ComputedTypeIdvariable · Re-export
Runtime symbol identifying read-only Computed values.
RefSubject.FilteredTypeIdvariable · Re-export
Runtime symbol identifying conditionally available Filtered values.
RefSubject.RefSubjectTypeIdvariable · Re-export
Runtime symbol identifying writable RefSubject values.
Type utilities
RefSubject.Computed.Anytype-alias · Re-export
Describes the any type.
RefSubject.Errortype-alias · Re-export
Describes the error type.
RefSubject.Filtered.Anytype-alias · Re-export
Describes the any type.
RefSubject.Identifiertype-alias · Re-export
Describes the identifier type.
RefSubject.RefSubject.Anytype-alias · Re-export
Describes the any type.
RefSubject.Servicestype-alias · Re-export
Describes the services type.
RefSubject.Successtype-alias · Re-export
Describes the success type.
Versioned.Versioned.Unifytype-alias · Re-export
Unifies a Versioned type.
Versioned.Versioned.VersionContexttype-alias · Re-export
Extracts the context required to get the version.
Versioned.Versioned.VersionErrortype-alias · Re-export
Extracts the error type of the version effect.
Unit conversions
RefDuration.daysvariable · Re-export
Get the days value of the current state of a RefDuration.
RefDuration.hoursvariable · Re-export
Get the hours value of the current state of a RefDuration.
RefDuration.millisvariable · Re-export
Get the milliseconds value of the current state of a RefDuration.
RefDuration.minutesvariable · Re-export
Get the minutes value of the current state of a RefDuration.
RefDuration.secondsvariable · Re-export
Get the seconds value of the current state of a RefDuration.
Value sources
Fx.emptyvariable · Re-export
An Fx that emits no values and completes immediately.
Fx.fromIterablevariable · Re-export
Creates an Fx from an Iterable. Emits each value from the iterable in order and then completes.
Fx.nevervariable · Re-export
An Fx that waits forever without emitting a value.
Fx.nullvariable · Re-export
An Fx that emits
nullexactly once and then completes.Fx.succeedvariable · Re-export
Creates an Fx that emits a single value and then completes.
Fx.succeedNullvariable · Re-export
An Fx that emits
nullexactly once and then completes.Fx.succeedUndefinedvariable · Re-export
An Fx that emits
undefinedexactly once and then completes.Fx.succeedVoidvariable · Re-export
An Fx that emits
voidexactly once and then completes.Fx.suspendvariable · Re-export
Defers creation of an
Fxuntil each run begins.Fx.syncvariable · Re-export
Lazily evaluates a synchronous function once for each Fx run.
Fx.undefinedvariable · Re-export
An Fx that emits
undefinedexactly once and then completes.Fx.voidvariable · Re-export
An Fx that emits
voidexactly once and then completes.
Writable state
RefSubject.RefSubjectinterface · Re-export
A
RefSubjectis a mutable reference that can be observed as an Fx. It combines the capabilities of aRef(get/set/update) with aSubject(subscribe).
Writable views
RefSubject.transformvariable · Re-export
Transforms a
RefSubjectinvariantly using bidirectional mapping functions.
models
Fx.Fx.Anytype-alias · Re-export
Matches any
Fxregardless of its value, error, or service channels.Fx.Fx.Classinterface · Re-export
The constructible service class returned by
Fx.Service.Fx.Fx.Varianceinterface · Re-export
Describes how an
Fxvaries in its value, error, and service channels.
namespace
Fxnamespace · Re-export
Public namespace exposed as Fx from @typed/fx.
Pushnamespace · Re-export
Public namespace exposed as Push from @typed/fx.
RefArraynamespace · Re-export
Public namespace exposed as RefArray from @typed/fx.
RefBigDecimalnamespace · Re-export
Public namespace exposed as RefBigDecimal from @typed/fx.
RefBigIntnamespace · Re-export
Public namespace exposed as RefBigInt from @typed/fx.
RefBooleannamespace · Re-export
Public namespace exposed as RefBoolean from @typed/fx.
RefCausenamespace · Re-export
Public namespace exposed as RefCause from @typed/fx.
RefChunknamespace · Re-export
Public namespace exposed as RefChunk from @typed/fx.
RefDateTimenamespace · Re-export
Public namespace exposed as RefDateTime from @typed/fx.
RefDurationnamespace · Re-export
Public namespace exposed as RefDuration from @typed/fx.
RefGraphnamespace · Re-export
Public namespace exposed as RefGraph from @typed/fx.
RefHashMapnamespace · Re-export
Public namespace exposed as RefHashMap from @typed/fx.
RefHashRingnamespace · Re-export
Public namespace exposed as RefHashRing from @typed/fx.
RefHashSetnamespace · Re-export
Public namespace exposed as RefHashSet from @typed/fx.
RefIterablenamespace · Re-export
Public namespace exposed as RefIterable from @typed/fx.
RefOptionnamespace · Re-export
Public namespace exposed as RefOption from @typed/fx.
RefRecordnamespace · Re-export
Public namespace exposed as RefRecord from @typed/fx.
RefResultnamespace · Re-export
Public namespace exposed as RefResult from @typed/fx.
RefStringnamespace · Re-export
Public namespace exposed as RefString from @typed/fx.
RefStructnamespace · Re-export
Public namespace exposed as RefStruct from @typed/fx.
RefSubjectnamespace · Re-export
Public namespace exposed as RefSubject from @typed/fx.
RefTrienamespace · Re-export
Public namespace exposed as RefTrie from @typed/fx.
RefTuplenamespace · Re-export
Public namespace exposed as RefTuple from @typed/fx.
Sinknamespace · Re-export
Public namespace exposed as Sink from @typed/fx.
Subjectnamespace · Re-export
Public namespace exposed as Subject from @typed/fx.
Versionednamespace · Re-export
Public namespace exposed as Versioned from @typed/fx.