interface / @typed/fx

RefSubject.RefSubjectOptions

Defines the ref subject options state contract.

Package version
2.0.0-beta.7
Category
Construction options
Since
1.18.0
Member of
RefSubject

Import

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

Access RefSubject.RefSubjectOptions through the imported RefSubject 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 interface RefSubjectOptions<A> {
    readonly eq?: Equivalence<A>;
}

Why

Configures equality for committed RefSubject values.

Ownership and lifetime

RefSubjectOptions is a contract and performs no acquisition. Implementations retain the errors, services, interruption, and Scope requirements expressed by its members.

Property: eq

Optional equivalence used to suppress unchanged commits.

Property: eq: Why

Suppresses publication and version changes when a candidate value is equivalent to the currently committed value.

Property: eq: Ownership and lifetime

This declaration performs no acquisition and retains no resources. Implementations preserve source errors, services, and lifetime.

Other public imports

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

Source