variable / @typed/fx

RefBoolean.setTrue

Set the current state of a RefBoolean to true.

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

Import

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

Access RefBoolean.setTrue through the imported RefBoolean 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 setTrue: <E, R>(ref: RefBoolean<E, R>) => Effect.Effect<boolean, E, R>;

Why

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

Ownership and lifetime

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