Skip to content

wirestate-mobx ​

Framework-agnostic MobX re-exports with Wirestate-friendly decorator aliases.

Define observable service state here once, then render it with @wirestate/react-mobx (React) or @wirestate/lit-mobx (Lit).

Classes ​

ClassDescription
FlowCancellationError-
ReactionReactions are a special kind of derivations. Several things distinguishes them from normal reactive computations

Functions ​

FunctionDescription
autorunCreates a named reactive view and keeps it alive, so that the view is always updated if one of the dependencies changes, even when the view is not further used by something else.
configure-
createAtom-
defineProperty-
entries-
extendObservable-
flowResult-
get-
getAtom-
getDebugName-
getDependencyTree-
getObserverTree-
has-
intercept-
isAction-
isComputed-
isComputedProp-
isFlow-
isFlowCancellationError-
isObservable-
isObservableArray-
isObservableObject-
isObservableProp-
keys-
makeAutoObservable-
makeObservable-
observe-
onBecomeObserved-
onBecomeUnobserved-
onReactionError-
ownKeys-
reaction-
remove-
runInAction-
set-
spy-
toJSRecursively converts an observable to it's non-observable native counterpart. It does NOT recurse into non-observables, these are left as they are, even if they contain observables. Computed and other non-enumerable properties are completely ignored. Complex scenarios require custom solution, eg implementing toJSON or using serializr lib.
trace-
transactionDuring a transaction no views are updated until the end of the transaction. The transaction will be run synchronously nonetheless.
untracked-
values-
when-

Interfaces ​

InterfaceDescription
IReactionPublicReactions are a special kind of derivations. Several things distinguishes them from normal reactive computations

MobX ​

NameDescription
ObservableMap-
ObservableSet-
IActionFactory-
IActionRunInfo-
IArraySplice-
IArrayUpdate-
IArrayWillChange-
IArrayWillSplice-
IAtom-
IAutorunOptions-
IComputedFactory-
IComputedValue-
IComputedValueOptions-
IDependencyTree-
IDepTreeNode-
IEnhancer-
IEqualsComparer-
IInterceptable-
IKeyValueMap-
IListenable-
IMapWillChange-
IObservable-
IObservableArray-
IObservableFactory-
IObservableValue-
IObserverTree-
IReactionDisposer-
IValueWillChange-
IWhenOptions-
Lambda-
AnnotationMapEntry-
AnnotationsMap-
CreateObservableOptions-
IArrayDidChange-
IInterceptor-
IMapDidChange-
IMapEntries-
IMapEntry-
IObjectDidChange-
IObjectWillChange-
IObservableMapInitialValues-
IObservableSetInitialValues-
IReactionOptions-
ISetDidChange-
ISetWillChange-
IValueDidChange-

MobX aliases ​

FunctionDescription
ActionMobX action decorator alias.
BoundActionMobX bound action decorator alias.
ComputedMobX computed decorator alias.
DeepObservableMobX deep observable decorator alias.
ObservableMobX observable decorator alias.
RefObservableMobX ref observable decorator alias.
ShallowObservableMobX shallow observable decorator alias.

Plugins ​

ClassDescription
ObservablePluginApplies MobX decorator annotations to every service the container activates.

Variables ​

VariableDescription
$mobx-
comparer-
flow-
isBoxedObservable-
isObservableMap-
isObservableSet-
override-