variable / @typed/fx

RefRecord.pop

Pop a value at a key as a Filtered.

Package version
2.0.0-beta.13
Category
Optional queries
Since
1.18.0
Member of
RefRecord

Import

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

Access RefRecord.pop 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 pop: {
    <K extends string>(key: K): <V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Filtered<[
        V,
        Record.ReadonlyRecord<K, V>
    ], E, R>;
    <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>, key: K): RefSubject.Filtered<[
        V,
        Record.ReadonlyRecord<K, V>
    ], E, R>;
};

Why

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

Ownership and lifetime

The pop 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