variable / @typed/fx

RefTrie.modify

Modify the value at a key if it exists.

Package version
2.0.0-beta.7
Category
State updates
Since
1.18.0
Member of
RefTrie

Import

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

Access RefTrie.modify through the imported RefTrie export. Its declaration below describes the member.

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

Signatures

export declare const modify: {
    <V>(key: string, f: (v: V) => V): <E, R>(ref: RefTrie<V, E, R>) => Effect.Effect<Trie.Trie<V>, E, R>;
    <V, E, R>(ref: RefTrie<V, E, R>, key: string, f: (v: V) => V): Effect.Effect<Trie.Trie<V>, E, R>;
};

Why

Keeps modify atomic with respect to competing RefSubject writes instead of splitting the read and replacement into separate effects.

Ownership and lifetime

Running modify performs one serialized trie transition and resolves with its committed value. It acquires no resource; failures and services remain those of the source ref.

Other public imports

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

Source