API Reference
The contract implemented by StateManager. Defines the full public API for watching, reading, writing, and releasing reactive state — plus the four observable streams (changed, contextChanged, startChangeCycle, endChangeCycle) that the expression runtime and application code subscribe to.
export interface IStateManager {
readonly changed: Observable<IStateChange>;
readonly contextChanged: Observable<IContextChanged>;
readonly startChangeCycle: Observable<IChangeCycleIndex>;
readonly endChangeCycle: Observable<IChangeCycleIndex>;
isWatched(
context: unknown,
index: unknown,
indexWatchRule?: IIndexWatchRule,
): boolean;
watchState(
context: unknown,
index: unknown,
options?: IStateOptions,
): unknown;
subscribeStateEvents(
context: unknown,
index: unknown,
listener: IStateEventListener,
): () => void;
releaseState(
context: unknown,import type { IStateManager } from '@rs-x/state-manager';11 members in this interface.
readonly changed: Observable<IStateChange>Type
Observable<IStateChange>
readonly contextChanged: Observable<IContextChanged>Type
Observable<IContextChanged>
readonly endChangeCycle: Observable<IChangeCycleIndex>Type
Observable<IChangeCycleIndex>
readonly startChangeCycle: Observable<IChangeCycleIndex>Type
Observable<IChangeCycleIndex>
clear(): voidParameters
No parameters.
Returns
void
getState<T>(
context: unknown,
index: unknown
): TParameters
| Name | Type | Required |
|---|---|---|
| context | unknown | required |
| index | unknown | required |
Returns
T
isWatched(
context: unknown,
index: unknown,
indexWatchRule?: IIndexWatchRule
): booleanParameters
| Name | Type | Required |
|---|---|---|
| context | unknown | required |
| index | unknown | required |
| indexWatchRule? | IIndexWatchRule | optional |
Returns
boolean
releaseState(
context: unknown,
index: unknown,
indexWatchRule?: IIndexWatchRule
): voidParameters
| Name | Type | Required |
|---|---|---|
| context | unknown | required |
| index | unknown | required |
| indexWatchRule? | IIndexWatchRule | optional |
Returns
void
setState<T>(
context: unknown,
index: unknown,
value: T,
ownerId?: unknown
): voidParameters
| Name | Type | Required |
|---|---|---|
| context | unknown | required |
| index | unknown | required |
| value | T | required |
| ownerId? | unknown | optional |
Returns
void
subscribeStateEvents(
context: unknown,
index: unknown,
listener: IStateEventListener
): () => voidParameters
| Name | Type | Required |
|---|---|---|
| context | unknown | required |
| index | unknown | required |
| listener | IStateEventListener | required |
Returns
() => void
watchState(
context: unknown,
index: unknown,
options?: IStateOptions
): unknownParameters
| Name | Type | Required |
|---|---|---|
| context | unknown | required |
| index | unknown | required |
| options? | IStateOptions | optional |
Returns
unknown