interface / @typed/fx

RefSubject.HydrateOptions

Defines the hydrate options state contract.

Package version
2.0.0-beta.7
Category
Hydration protocol
Since
2.0.0
Member of
RefSubject

Import

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

Access RefSubject.HydrateOptions 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 HydrateOptions<A> extends RefSubjectOptions<A> {
    readonly name?: string;
}

Why

Adds an optional stable attribute name to ordinary RefSubject initialization and equality options.

Ownership and lifetime

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

Property: name

Optional stable name for a dedicated hydration attribute.

Property: name: Why

Carries the exact attribute name used for a serialized value.

Property: name: Ownership and lifetime

This declaration acquires no resources. Effects represented by the contract retain their own services and Scope requirements.

Other public imports

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

Source