variable / @typed/fx

RefStruct.omit

Omit properties from the current state of a RefStruct.

Package version
2.0.0-beta.13
Category
Derived queries
Since
1.18.0
Member of
RefStruct

Import

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

Access RefStruct.omit through the imported RefStruct 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 omit: {
    <S extends object, const Keys extends ReadonlyArray<keyof S>>(keys: Keys): <E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<Omit<S, Keys[number]>, E, R>;
    <S extends object, const Keys extends ReadonlyArray<keyof S>, E, R>(ref: RefStruct<S, E, R>, keys: Keys): RefSubject.Computed<Omit<S, Keys[number]>, E, R>;
};

Why

Projects struct state with omit for both current reads and future pushes, avoiding a second mutable cache of the derived value.

Ownership and lifetime

The omit view retains no independent state. An Effect read samples the source once; Fx observation follows later pushes and its observing Scope owns subscription cleanup.

Other public imports

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

Source