variable / @typed/fx

RefResult.getSuccess

Get the success value from the Result as a Filtered (fails if Failure).

Package version
2.0.0-beta.7
Category
Optional queries
Since
1.18.0
Member of
RefResult

Import

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

Access RefResult.getSuccess through the imported RefResult 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 getSuccess: <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Filtered<A, Err, R>;

Why

Models the possibly absent result of get success as Filtered state, so absence stays explicit while later source versions can make a value available.

Ownership and lifetime

The get success view retains no independent value. Its Effect read fails with NoSuchElement while absent; the observing Scope owns and finalizes its Fx subscription.

Other public imports

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

Source