variable / @typed/fx

RefCause.setDie

Set the current state of a RefCause to a Die cause.

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

Import

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

Access RefCause.setDie through the imported RefCause 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 setDie: {
    (defect: unknown): <E, Err, R>(ref: RefCause<E, Err, R>) => Effect.Effect<Cause.Cause<E>, Err, R>;
    <E, Err, R>(ref: RefCause<E, Err, R>, defect: unknown): Effect.Effect<Cause.Cause<E>, Err, R>;
};

Why

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

Ownership and lifetime

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