rx
Classes
| Class | Description |
|---|---|
| Ref | A lazy, serializable reference to a row in a collection. The expression is evaluated at runtime by the renderer's pipe evaluator. |
| Collection | A named keyed array. Serializes rows into state and provides typed lookup helpers that compile to pipe expressions. |
| Rx | Rx — Reactive expression builder. |
| Signal | A named reactive scalar. Carries a state key, an initial value, and produces rx expressions for component props. |
Interfaces
| Interface | Description |
|---|---|
| SignalOptions | - |
Type Aliases
| Type Alias | Description |
|---|---|
| PipeFn | A pipe function receives the current value and optional arguments. |
| SignalValue | Allowed signal value types — intentionally excludes objects/arrays. |
Variables
| Variable | Description |
|---|---|
| ITEM | Current item in a ForEach loop |
| INDEX | Current index in a ForEach loop |
| EVENT | Value from an interaction event (input value, checkbox state, etc.) |
| ERROR | Error message available in on_error callbacks |
| RESULT | Return value available in on_success callbacks |
| STATE | STATE proxy — convenience for accessing state keys. Usage: STATE.foo → rx('foo'), STATE.user.name → rx('user.name') |
Functions
| Function | Description |
|---|---|
| collection | Create a named keyed collection. |
| registerPipe | Register a custom pipe filter. Re-registration warns and overwrites (HMR-friendly). Built-in pipes in applyFilter always shadow custom pipes. |
| unregisterPipe | Remove a custom pipe (useful in tests). Returns true if it existed. |
| listPipes | List all registered custom pipe names (useful for debugging). |
| rx | Create an Rx expression referencing a state key |
| signal | Create a named reactive signal. |