interface / @typed/fx

RefSubject.HydrationAttribute

Defines the hydration attribute 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.HydrationAttribute 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 HydrationAttribute {
    readonly name: string;
    readonly value: string;
}

Why

Represents one exact name/value pair a server renderer can write without depending on a DOM implementation.

Ownership and lifetime

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

Property: name

Exact DOM attribute name for one serialized payload.

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.

Property: value

Schema-encoded payload written to the hydration attribute.

Property: value: Why

Carries the already encoded attribute payload; encoding failures occur before this record is produced.

Property: value: 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