interface / @typed/fx

RefStruct.RefStruct

A RefStruct is a RefSubject specialized over a struct value.

Package version
2.0.0-beta.13
Category
State models
Since
1.18.0
Member of
RefStruct

Import

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

Access RefStruct.RefStruct 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 interface RefStruct<in out S extends object, in out E = never, out R = never> extends RefSubject.RefSubject<S, E, R> {
}

Why

Defines struct state with the same current-read, pushed-update, and synchronized-write contract as RefSubject.

Ownership and lifetime

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

Other public imports

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

Source