variable / @typed/fx

RefRecord.set

Set a key-value pair in the Record.

Package version
2.0.0-beta.13
Category
State updates
Since
1.18.0
Member of
RefRecord

Import

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

Access RefRecord.set through the imported RefRecord 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 set: {
    <K extends string, V>(key: K, value: V): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
    <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>, key: K, value: V): Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
};

Why

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

Ownership and lifetime

Running set performs one serialized record 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