UNPKG

mobx-view-model

Version:

MobX ViewModel power for ReactJS

github.com/js2me/mobx-view-model

js2me/mobx-view-model

39 lines • 2.66 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import { ViewModelsConfig } from '../config/types.js'; import { AnyObject, EmptyObject } from '../utils/types.js'; import { AnyViewModel } from './view-model.types.js'; /** * The main interface for all view models. * * [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface) */ export interface ViewModel<Payload extends AnyObject = EmptyObject, ParentViewModel extends AnyViewModel | null = null> { /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#id-string) */ readonly id: string; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#vmconfig-viewmodelconfig) */ readonly vmConfig: ViewModelsConfig; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#payload-payload) */ readonly payload: Payload; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#ismounted-boolean) */ readonly isMounted: boolean; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#isunmounting-boolean) */ readonly isUnmounting: boolean; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#parentviewmodel-parentviewmodel-null) */ readonly parentViewModel: ParentViewModel; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#willmount-void) */ willMount(): void; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#mount-void-promise-void) */ mount(): void | Promise<void>; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#didmount-void) */ didMount(): void; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#didunmount-void) */ didUnmount(): void; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#willunmount-void) */ willUnmount(): void; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#unmount-void-promise-void) */ unmount(): void | Promise<void>; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#setpayload-payload-payload-void) */ setPayload(payload: Payload): void; /** [**Documentation**](https://js2me.github.io/mobx-view-model/api/view-models/interface#payloadchanged-payload-payload-prevpayload-payload-void) */ payloadChanged(payload: Payload, prevPayload: Payload): void; } //# sourceMappingURL=view-model.d.ts.map