@maxhealth.tech/prefab / rx / Signal

Class: Signal<T>

Defined in: rx/signal.ts:34

A named reactive scalar. Carries a state key, an initial value, and produces rx expressions for component props.

Type Parameters

Type Parameter	Default type
T extends SignalValue	SignalValue

Constructors

Constructor

new Signal<T>(
   key, 
   initial, 
options?): Signal<T>;

Defined in: rx/signal.ts:39

Parameters

Parameter	Type
key	string
initial	T
options?	SignalOptions

Returns

Signal<T>

Properties

key

readonly key: string;

Defined in: rx/signal.ts:35

---

initial

readonly initial: T;

Defined in: rx/signal.ts:36

---

options?

readonly optional options?: SignalOptions;

Defined in: rx/signal.ts:37

Methods

toRx()

toRx(): Rx;

Defined in: rx/signal.ts:46

Rx expression referencing this signal's value: {{ key }}

Returns

Rx

---

toString()

toString(): string;

Defined in: rx/signal.ts:51

Serialize to the rx template string

Returns

string

---

toJSON()

toJSON(): string;

Defined in: rx/signal.ts:55

Returns

string

---

toState()

toState(): Record<string, T>;

Defined in: rx/signal.ts:60

State entry for PrefabApp: { key: initial }

Returns

Record<string, T>