variable / @typed/fx/RefResult

setFailure

Set the current state of a RefResult to Failure(error).

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

Import

import { setFailure } from "@typed/fx/RefResult";

Signatures

export declare const setFailure: {
    <ResultE>(error: ResultE): <A, Err, R>(ref: RefResult<A, ResultE, Err, R>) => Effect.Effect<Result.Result<A, ResultE>, Err, R>;
    <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>, error: ResultE): Effect.Effect<Result.Result<A, ResultE>, Err, R>;
};

Why

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

Ownership and lifetime

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