tripolskypetr commited on
Commit
9375fc1
·
1 Parent(s): 1bc1462
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. .gitkeep +0 -0
  2. .nojekyll +1 -0
  3. LICENSE +21 -0
  4. README.md +28 -1
  5. assets/hierarchy.js +1 -0
  6. assets/highlight.css +169 -0
  7. assets/icons.js +18 -0
  8. assets/icons.svg +1 -0
  9. assets/main.js +60 -0
  10. assets/navigation.js +1 -0
  11. assets/search.js +0 -0
  12. assets/style.css +1611 -0
  13. classes/types.react-declarative.ArraySet.html +0 -0
  14. classes/types.react-declarative.AutoSizer.html +36 -0
  15. classes/types.react-declarative.BehaviorSubject.html +0 -0
  16. classes/types.react-declarative.ChatController.html +57 -0
  17. classes/types.react-declarative.Collection.html +0 -0
  18. classes/types.react-declarative.Entity.html +67 -0
  19. classes/types.react-declarative.EntityNotFoundError.html +6 -0
  20. classes/types.react-declarative.ErrorBoundary.html +32 -0
  21. classes/types.react-declarative.EventEmitter.html +34 -0
  22. classes/types.react-declarative.FetchError.html +10 -0
  23. classes/types.react-declarative.Model.html +66 -0
  24. classes/types.react-declarative.NoSsr.html +7 -0
  25. classes/types.react-declarative.Observer.html +0 -0
  26. classes/types.react-declarative.OneConfig.html +5 -0
  27. classes/types.react-declarative.Operator.html +11 -0
  28. classes/types.react-declarative.PortalView.html +16 -0
  29. classes/types.react-declarative.ReloadView.html +18 -0
  30. classes/types.react-declarative.RouteManager.html +0 -0
  31. classes/types.react-declarative.Source.html +0 -0
  32. classes/types.react-declarative.Subject.html +0 -0
  33. classes/types.react-declarative.SubjectBinding.html +6 -0
  34. classes/types.react-declarative.Task.html +12 -0
  35. classes/types.react-declarative.Translate.html +37 -0
  36. classes/types.react-declarative.serviceManager.html +49 -0
  37. classes/types.react-declarative_components.AudioMediaRecorder.html +19 -0
  38. classes/types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html +5 -0
  39. classes/types.react-declarative_hooks_useCollection.CollectionAdapter.html +110 -0
  40. classes/types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html +31 -0
  41. classes/types.react-declarative_hooks_useEntity.EntityAdapter.html +30 -0
  42. classes/types.react-declarative_hooks_useModel.ModelAdapter.html +24 -0
  43. classes/types.react-declarative_utils_datetime.Date.html +20 -0
  44. classes/types.react-declarative_utils_datetime.Time.html +19 -0
  45. documents/docs_advanced_ai-integration.html +99 -0
  46. documents/docs_advanced_dependency-injection.html +73 -0
  47. documents/docs_advanced_reactive-programming.html +87 -0
  48. documents/docs_advanced_slot-factory.html +170 -0
  49. documents/docs_api_components_kanban-view.html +113 -0
  50. documents/docs_api_components_list.html +151 -0
.gitkeep ADDED
File without changes
.nojekyll ADDED
@@ -0,0 +1 @@
 
 
1
+ TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
LICENSE ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2026 react-declarative
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md CHANGED
@@ -7,4 +7,31 @@ sdk: static
7
  pinned: false
8
  ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ # react-declarative-docs
11
+
12
+ > Docs for [react-declarative](https://github.com/react-declarative/react-declarative) — a TypeScript/React library built on MUI for building forms, data grids, and app shells from JSON schemas.
13
+
14
+ ## Repo structure
15
+
16
+ ```
17
+ source/ # Mintlify site (.mdx + docs.json)
18
+ typed.d.ts # Bundled type declarations (TypeDoc entry point)
19
+ typedoc.json # TypeDoc config
20
+ ```
21
+
22
+ ### Doc sections
23
+
24
+ | Section | Content |
25
+ |---|---|
26
+ | Get Started | Introduction, installation, quickstart |
27
+ | Core Concepts | Field schemas, field types (40+), layout containers, state management |
28
+ | Components | One, List, Scaffold, KanbanView, WizardView |
29
+ | Guides | Validation, conditional fields, custom fields, async data, routing |
30
+ | Advanced | Slot factory, DI container, reactive programming, AI integration |
31
+ | API Reference | Full props, hooks, and types reference |
32
+
33
+ ## Links
34
+
35
+ - [react-declarative on GitHub](https://github.com/react-declarative/react-declarative)
36
+ - [Interactive playground](https://react-declarative-playground.github.io/)
37
+ - [Mintlify](https://mintlify.com)
assets/hierarchy.js ADDED
@@ -0,0 +1 @@
 
 
1
+ window.hierarchyData = "eJy9nFtz27oRx7+LnhGUIMAL/Jb4JK1mTk4ysaedTsejoSUkYk0RKkk5ds/4u3cAUhSWlxikwb4wkhL+97dYEpfFIn+uCimrcnX1r4j7HiJxTDgifkwJohGNEWGEcnX1A0S4TxkizIsidQ0jRHwSU0T8IAgRYX7IUBz7vvpB3Rr5caBu9ZSAx9VNNFAClKjfaewh4gVeiIjHeYiIH1Ki7gqpukYMRTQMEYk9QhFhzFM0lCsxRn119Ym6hj7SoEHgqa+xshDE6h8EkYci7qmPsf4hjgjiVIEzrth8bcuncXSHVoX4noltlcq8XF39uaKxuubJQayuVuub9L9ihVYPab5bXflBiFanIltdrdK8EsX3ZCvKv1TPR1HiQiTb6t1ObLOkSKr0UWB9L95Xh2yFVtssKcvV1aoqd++U2LtWQP3lPs12hchVNBjz717QKvIDA+ObPFXic5InP0TR0hA/PtNo9V+gmPePEtU/vKAVDUlkGP8g9sljKoub0/2/xbaaY78jYYEQgTB8fBR59fGQVtU8/837XzEOosEYCRALGb/TTJFvMH25L0XxOI/nfK9FQ/DYNPqGGNi1PXwY/QCph0F5r5rCALmWWfPSzGG53P16C7AgIuajkFdp9TzrIdB3WhgMGTcMfpY7kc2xp2+c9LQFEVFNHRAWmn3Q9V5sHz7Ip5tMVvP6os1WHo4yF3lVYiBn0T1poDAAQPJwL13RnLUsUXxiBme9rsShdITSatmiRNRE+T3NhSOSs5QtSAxAvhbyRyFKV81iytkCcWYCfUt2qavnpdWyRKGg21p/S6o0/+GM5SxmC0NBu9xk6U4UjmAuYpYwzANv0s3PtNruXcG0YpYwAQHTrtvno/xRJMf9syMgKGgJFUWeCfVPUf7h6jFutSxROAfB+nCqKpk7YrmI2cGEhPbHp3v5dC2yzOUYZUjagal1A+gIk6Mo/p6Kn18LeSxddIVAcPLcnsZ6fFd/mpi/FfL4vhCJK0qgZ9lyjPkwpGm2+5oUycEFkKFmicM9gHNbCKGa/Q+5m7kag52BITc1iCRgXqijyH2zd3ivp7PfxH9OonTwBgC5yQ8a9wMUcUrUJUIRZ+proC4ha9jNUfH9aZdK1w70NG1DT82X4/pUVvLgmG1A1BrOXBl/SjPhGK0naQvGzIB+PmVVeiPUGssx35iyLWZgYi5C+Aa40Jyd3Yon12g9STswlVsze8POEngazkGtSjeNBl6/sige7QQ51WkqlVQz0f5RJMej2P2ePMvT3AZrCOt01Q5DzamknKk8I/U5QYRSRhGhgR8jQmN95VRlJD2vdoZ5YPrQEDh1BmhOdybQKVKP1bgBHcC92SdZJn+65W1E7Z5XndyFK+Oyuk6y7D7ZPsydTzRgSqqe10DVyU+wFwR6GNcfwKRRlql6ResXVRl5w5y2Tz0sb9uwnMMnVOSnL0eQhZsXbpGf/lrI0xEbkpOblHhUP5j6QxdTyzulrD/aNRyhoTmr0Km597vkOC+fvNlL+VBuTqWoc3ym3Ov5RUKY189ouqBpOnMgaMXDzMX3JTnrjsxI+I7IW3FGwynoxQjt2dSGGFhAZSIpkvts7nLlVKVZudnL75uDOEi1kXSRnPxi+j7RC0/9YRnKqsqmEdY41FxC3Y7tNM2BKp423V2nrv7UdjxvhejtQ5O7txU0E7jdFrp9dYNoDDGK/BqRxubE7NZRk7ZNObcJudqPVXGvKQO42zrc4cxhPTw+HjZwkvvayzw6rDEWI7U3g3TP3YDDScN4XzQb3uiQ+vJTndAbmboDrfFDsMheD46Hs8nrQXFtNSqO8YaMIz1q17wx4P1N3MtTvhW7a5lXhcw+nfJm//6tS7TNl9wYEy52mmkmHrU8vU+O2dk3NujbTZVUb092WTukzVn222o5BRKY6WO9oHGTwdTMmRYsN6027pixZaUMDMwf5NNirK027pixZoXT+9vkvlwM9iKOu4ZscRlc/F8L9deLAZvyuG/MFjrwYYFPVYhqu1+MGujjAXPW3HDTQK9+FqM21HHPlC1xCDq29ZdTlaW5WIwZ6OMBc7bcEdx80Js+i1Eb6rhnypoY1md8fDomeanSC0tRdyzgQZO29DF8I/8mCrkY+EUcdw3Z4nLaKYbJdzqjs1zHBy3gQZOW9CrXCej1Vshy6IY87huzhu4MNM3u8KdUZDuH1N+VXrkB8njA2tTJnirouqsdiX7lSProbMpn5Yq29wZnOHBmvZX5QhFppXHHyuRpN/dYnaNU5ckj9O7DMMw/q/lND8AmblPGsVAEDHHcszT5EeKcNy7QgbKWxcIw7sS8N6F1wwc7h3VN43LvdKuO+5amv81hnRJgnUI5XQy51OvcauOuncn8PmliQAM2xr/ACz3iwbwYXHyIQcGZKgNdKAStNO5YmQ4f0QYelqidy0YXcgDI4wFr0x2JG0eYF//CEfcP069dmflItc74YBGmy2cXCslFG3ftTOfnzSDHqD/G7z4SYx7MjEHrQ9jxQZUNL+hEK48HbE12g5JmhGDxQPXyQs+SIY57lqa70GxMq7Nioy64j8S4EzMj0boBC5PrauulInERxz1Lk11gXjPUBeBcExReIBKjTsyLROtGDA4nGWXmC0WjYwAPWpzsTkDixh0YlZ64+8i87tC8CLUu8RjMa3Xh/WLeXNRx39JkH6Ko3iYNOoVpqn75DaXQTTnNWQVfPtmlY1TxH5imvqVArtOOxtdD8tAmc63r5RSfKpDrpcodvYpbeTjIfNOUIV2UJy/j1V4P0lsoSOf2kc6XI519Rjqje1f7AkoNzlltt940ohioT/cobHY01RnuXgLdLbGWxIbydNqoLvrUp9UHk+duiVtZ3LEwg7x5NtQBedjOTs5rdN/DxgFVcqeXunhtfZQDgscePYPDFLqrAuvXySfVXev/FGHgiEd5lHnpYNy43ieVOobSdMhQHne+Tm7sOCTqv3UIY3WNmLrG+hdVCh3zppBF/bOxkyBL+dm3gYd+s41RCIoXwdGOhTwYMoIHf7T1AXSY5hmQhTzom8ADP9nSg53pgRMiCzkxamnolMpEl0CBy//Fm0Hct/jAQZWxefZkIQ/6JvDAT3b0apejuz3j5GypHiPKTFb1rowuvm/VbeF8WN9unlZ1NGtQBwPM74ruU7KtZPEMI3CxDL7gPtTUIUQd8717eXn5H6LbAuo="
assets/highlight.css ADDED
@@ -0,0 +1,169 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ :root {
2
+ --light-hl-0: #AF00DB;
3
+ --dark-hl-0: #C586C0;
4
+ --light-hl-1: #000000;
5
+ --dark-hl-1: #D4D4D4;
6
+ --light-hl-2: #001080;
7
+ --dark-hl-2: #9CDCFE;
8
+ --light-hl-3: #A31515;
9
+ --dark-hl-3: #CE9178;
10
+ --light-hl-4: #0000FF;
11
+ --dark-hl-4: #569CD6;
12
+ --light-hl-5: #795E26;
13
+ --dark-hl-5: #DCDCAA;
14
+ --light-hl-6: #800000;
15
+ --dark-hl-6: #808080;
16
+ --light-hl-7: #267F99;
17
+ --dark-hl-7: #4EC9B0;
18
+ --light-hl-8: #E50000;
19
+ --dark-hl-8: #9CDCFE;
20
+ --light-hl-9: #000000FF;
21
+ --dark-hl-9: #D4D4D4;
22
+ --light-hl-10: #0070C1;
23
+ --dark-hl-10: #4FC1FF;
24
+ --light-hl-11: #811F3F;
25
+ --dark-hl-11: #D16969;
26
+ --light-hl-12: #EE0000;
27
+ --dark-hl-12: #DCDCAA;
28
+ --light-hl-13: #D16969;
29
+ --dark-hl-13: #CE9178;
30
+ --light-hl-14: #EE0000;
31
+ --dark-hl-14: #D7BA7D;
32
+ --light-hl-15: #000000;
33
+ --dark-hl-15: #D7BA7D;
34
+ --light-hl-16: #098658;
35
+ --dark-hl-16: #B5CEA8;
36
+ --light-hl-17: #008000;
37
+ --dark-hl-17: #6A9955;
38
+ --light-hl-18: #800000;
39
+ --dark-hl-18: #569CD6;
40
+ --light-hl-19: #CD3131;
41
+ --dark-hl-19: #F44747;
42
+ --light-hl-20: #000000;
43
+ --dark-hl-20: #C8C8C8;
44
+ --light-code-background: #FFFFFF;
45
+ --dark-code-background: #1E1E1E;
46
+ }
47
+
48
+ @media (prefers-color-scheme: light) { :root {
49
+ --hl-0: var(--light-hl-0);
50
+ --hl-1: var(--light-hl-1);
51
+ --hl-2: var(--light-hl-2);
52
+ --hl-3: var(--light-hl-3);
53
+ --hl-4: var(--light-hl-4);
54
+ --hl-5: var(--light-hl-5);
55
+ --hl-6: var(--light-hl-6);
56
+ --hl-7: var(--light-hl-7);
57
+ --hl-8: var(--light-hl-8);
58
+ --hl-9: var(--light-hl-9);
59
+ --hl-10: var(--light-hl-10);
60
+ --hl-11: var(--light-hl-11);
61
+ --hl-12: var(--light-hl-12);
62
+ --hl-13: var(--light-hl-13);
63
+ --hl-14: var(--light-hl-14);
64
+ --hl-15: var(--light-hl-15);
65
+ --hl-16: var(--light-hl-16);
66
+ --hl-17: var(--light-hl-17);
67
+ --hl-18: var(--light-hl-18);
68
+ --hl-19: var(--light-hl-19);
69
+ --hl-20: var(--light-hl-20);
70
+ --code-background: var(--light-code-background);
71
+ } }
72
+
73
+ @media (prefers-color-scheme: dark) { :root {
74
+ --hl-0: var(--dark-hl-0);
75
+ --hl-1: var(--dark-hl-1);
76
+ --hl-2: var(--dark-hl-2);
77
+ --hl-3: var(--dark-hl-3);
78
+ --hl-4: var(--dark-hl-4);
79
+ --hl-5: var(--dark-hl-5);
80
+ --hl-6: var(--dark-hl-6);
81
+ --hl-7: var(--dark-hl-7);
82
+ --hl-8: var(--dark-hl-8);
83
+ --hl-9: var(--dark-hl-9);
84
+ --hl-10: var(--dark-hl-10);
85
+ --hl-11: var(--dark-hl-11);
86
+ --hl-12: var(--dark-hl-12);
87
+ --hl-13: var(--dark-hl-13);
88
+ --hl-14: var(--dark-hl-14);
89
+ --hl-15: var(--dark-hl-15);
90
+ --hl-16: var(--dark-hl-16);
91
+ --hl-17: var(--dark-hl-17);
92
+ --hl-18: var(--dark-hl-18);
93
+ --hl-19: var(--dark-hl-19);
94
+ --hl-20: var(--dark-hl-20);
95
+ --code-background: var(--dark-code-background);
96
+ } }
97
+
98
+ :root[data-theme='light'] {
99
+ --hl-0: var(--light-hl-0);
100
+ --hl-1: var(--light-hl-1);
101
+ --hl-2: var(--light-hl-2);
102
+ --hl-3: var(--light-hl-3);
103
+ --hl-4: var(--light-hl-4);
104
+ --hl-5: var(--light-hl-5);
105
+ --hl-6: var(--light-hl-6);
106
+ --hl-7: var(--light-hl-7);
107
+ --hl-8: var(--light-hl-8);
108
+ --hl-9: var(--light-hl-9);
109
+ --hl-10: var(--light-hl-10);
110
+ --hl-11: var(--light-hl-11);
111
+ --hl-12: var(--light-hl-12);
112
+ --hl-13: var(--light-hl-13);
113
+ --hl-14: var(--light-hl-14);
114
+ --hl-15: var(--light-hl-15);
115
+ --hl-16: var(--light-hl-16);
116
+ --hl-17: var(--light-hl-17);
117
+ --hl-18: var(--light-hl-18);
118
+ --hl-19: var(--light-hl-19);
119
+ --hl-20: var(--light-hl-20);
120
+ --code-background: var(--light-code-background);
121
+ }
122
+
123
+ :root[data-theme='dark'] {
124
+ --hl-0: var(--dark-hl-0);
125
+ --hl-1: var(--dark-hl-1);
126
+ --hl-2: var(--dark-hl-2);
127
+ --hl-3: var(--dark-hl-3);
128
+ --hl-4: var(--dark-hl-4);
129
+ --hl-5: var(--dark-hl-5);
130
+ --hl-6: var(--dark-hl-6);
131
+ --hl-7: var(--dark-hl-7);
132
+ --hl-8: var(--dark-hl-8);
133
+ --hl-9: var(--dark-hl-9);
134
+ --hl-10: var(--dark-hl-10);
135
+ --hl-11: var(--dark-hl-11);
136
+ --hl-12: var(--dark-hl-12);
137
+ --hl-13: var(--dark-hl-13);
138
+ --hl-14: var(--dark-hl-14);
139
+ --hl-15: var(--dark-hl-15);
140
+ --hl-16: var(--dark-hl-16);
141
+ --hl-17: var(--dark-hl-17);
142
+ --hl-18: var(--dark-hl-18);
143
+ --hl-19: var(--dark-hl-19);
144
+ --hl-20: var(--dark-hl-20);
145
+ --code-background: var(--dark-code-background);
146
+ }
147
+
148
+ .hl-0 { color: var(--hl-0); }
149
+ .hl-1 { color: var(--hl-1); }
150
+ .hl-2 { color: var(--hl-2); }
151
+ .hl-3 { color: var(--hl-3); }
152
+ .hl-4 { color: var(--hl-4); }
153
+ .hl-5 { color: var(--hl-5); }
154
+ .hl-6 { color: var(--hl-6); }
155
+ .hl-7 { color: var(--hl-7); }
156
+ .hl-8 { color: var(--hl-8); }
157
+ .hl-9 { color: var(--hl-9); }
158
+ .hl-10 { color: var(--hl-10); }
159
+ .hl-11 { color: var(--hl-11); }
160
+ .hl-12 { color: var(--hl-12); }
161
+ .hl-13 { color: var(--hl-13); }
162
+ .hl-14 { color: var(--hl-14); }
163
+ .hl-15 { color: var(--hl-15); }
164
+ .hl-16 { color: var(--hl-16); }
165
+ .hl-17 { color: var(--hl-17); }
166
+ .hl-18 { color: var(--hl-18); }
167
+ .hl-19 { color: var(--hl-19); }
168
+ .hl-20 { color: var(--hl-20); }
169
+ pre, code { background: var(--code-background); }
assets/icons.js ADDED
@@ -0,0 +1,18 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ (function() {
2
+ addIcons();
3
+ function addIcons() {
4
+ if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons);
5
+ const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg"));
6
+ svg.innerHTML = `<g id="icon-1" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-2" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">N</text></g><g id="icon-8" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">E</text></g><g id="icon-16" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-32" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">V</text></g><g id="icon-64" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-128" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-256" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">I</text></g><g id="icon-512" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-1024" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-2048" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-method)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4096" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-8192" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-16384" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-32768" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-65536" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-131072" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-262144" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-524288" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-1048576" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-2097152" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-4194304" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-reference)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">R</text></g><g id="icon-8388608" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="6,5 6,19 18,19, 18,10 13,5"></polygon><line x1="9" y1="9" x2="13" y2="9"></line><line x1="9" y1="12" x2="15" y2="12"></line><line x1="9" y1="15" x2="15" y2="15"></line></g></g><g id="icon-folder" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="5,5 10,5 12,8 19,8 19,18 5,18"></polygon></g></g><g id="icon-chevronDown" class="tsd-no-select"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-icon-text)"></path></g><g id="icon-chevronSmall" class="tsd-no-select"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-icon-text)"></path></g><g id="icon-checkbox" class="tsd-no-select"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></g><g id="icon-menu" class="tsd-no-select"><rect x="1" y="3" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-icon-text)"></rect></g><g id="icon-search" class="tsd-no-select"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-icon-text)"></path></g><g id="icon-anchor" class="tsd-no-select"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g><g id="icon-alertNote" class="tsd-no-select"><path fill="var(--color-alert-note)" d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></g><g id="icon-alertTip" class="tsd-no-select"><path fill="var(--color-alert-tip)" d="M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z"></path></g><g id="icon-alertImportant" class="tsd-no-select"><path fill="var(--color-alert-important)" d="M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></g><g id="icon-alertWarning" class="tsd-no-select"><path fill="var(--color-alert-warning)" d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></g><g id="icon-alertCaution" class="tsd-no-select"><path fill="var(--color-alert-caution)" d="M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></g>`;
7
+ svg.style.display = "none";
8
+ if (location.protocol === "file:") updateUseElements();
9
+ }
10
+
11
+ function updateUseElements() {
12
+ document.querySelectorAll("use").forEach(el => {
13
+ if (el.getAttribute("href").includes("#icon-")) {
14
+ el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#"));
15
+ }
16
+ });
17
+ }
18
+ })()
assets/icons.svg ADDED
assets/main.js ADDED
@@ -0,0 +1,60 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ "use strict";
2
+ window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"};
3
+ "use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i<r.length;i++){var s=r[i],o=e[s];if(Array.isArray(o)){n[s]=o.slice();continue}if(typeof o=="string"||typeof o=="number"||typeof o=="boolean"){n[s]=o;continue}throw new TypeError("clone is not deep and does not support nested objects")}return n},t.FieldRef=function(e,n,r){this.docRef=e,this.fieldName=n,this._stringValue=r},t.FieldRef.joiner="/",t.FieldRef.fromString=function(e){var n=e.indexOf(t.FieldRef.joiner);if(n===-1)throw"malformed field ref string";var r=e.slice(0,n),i=e.slice(n+1);return new t.FieldRef(i,r,e)},t.FieldRef.prototype.toString=function(){return this._stringValue==null&&(this._stringValue=this.fieldName+t.FieldRef.joiner+this.docRef),this._stringValue};t.Set=function(e){if(this.elements=Object.create(null),e){this.length=e.length;for(var n=0;n<this.length;n++)this.elements[e[n]]=!0}else this.length=0},t.Set.complete={intersect:function(e){return e},union:function(){return this},contains:function(){return!0}},t.Set.empty={intersect:function(){return this},union:function(e){return e},contains:function(){return!1}},t.Set.prototype.contains=function(e){return!!this.elements[e]},t.Set.prototype.intersect=function(e){var n,r,i,s=[];if(e===t.Set.complete)return this;if(e===t.Set.empty)return e;this.length<e.length?(n=this,r=e):(n=e,r=this),i=Object.keys(n.elements);for(var o=0;o<i.length;o++){var a=i[o];a in r.elements&&s.push(a)}return new t.Set(s)},t.Set.prototype.union=function(e){return e===t.Set.complete?t.Set.complete:e===t.Set.empty?this:new t.Set(Object.keys(this.elements).concat(Object.keys(e.elements)))},t.idf=function(e,n){var r=0;for(var i in e)i!="_index"&&(r+=Object.keys(e[i]).length);var s=(n-r+.5)/(r+.5);return Math.log(1+Math.abs(s))},t.Token=function(e,n){this.str=e||"",this.metadata=n||{}},t.Token.prototype.toString=function(){return this.str},t.Token.prototype.update=function(e){return this.str=e(this.str,this.metadata),this},t.Token.prototype.clone=function(e){return e=e||function(n){return n},new t.Token(e(this.str,this.metadata),this.metadata)};t.tokenizer=function(e,n){if(e==null||e==null)return[];if(Array.isArray(e))return e.map(function(m){return new t.Token(t.utils.asString(m).toLowerCase(),t.utils.clone(n))});for(var r=e.toString().toLowerCase(),i=r.length,s=[],o=0,a=0;o<=i;o++){var l=r.charAt(o),c=o-a;if(l.match(t.tokenizer.separator)||o==i){if(c>0){var d=t.utils.clone(n)||{};d.position=[a,c],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index.
4
+ `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r<n;r++){for(var i=this._stack[r],s=[],o=0;o<e.length;o++){var a=i(e[o],o,e);if(!(a==null||a===""))if(Array.isArray(a))for(var l=0;l<a.length;l++)s.push(a[l]);else s.push(a)}e=s}return e},t.Pipeline.prototype.runString=function(e,n){var r=new t.Token(e,n);return this.run([r]).map(function(i){return i.toString()})},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})};t.Vector=function(e){this._magnitude=0,this.elements=e||[]},t.Vector.prototype.positionForIndex=function(e){if(this.elements.length==0)return 0;for(var n=0,r=this.elements.length/2,i=r-n,s=Math.floor(i/2),o=this.elements[s*2];i>1&&(o<e&&(n=s),o>e&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(o<e)return(s+1)*2},t.Vector.prototype.insert=function(e,n){this.upsert(e,n,function(){throw"duplicate index"})},t.Vector.prototype.upsert=function(e,n,r){this._magnitude=0;var i=this.positionForIndex(e);this.elements[i]==e?this.elements[i+1]=r(this.elements[i+1],n):this.elements.splice(i,0,e,n)},t.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var e=0,n=this.elements.length,r=1;r<n;r+=2){var i=this.elements[r];e+=i*i}return this._magnitude=Math.sqrt(e)},t.Vector.prototype.dot=function(e){for(var n=0,r=this.elements,i=e.elements,s=r.length,o=i.length,a=0,l=0,c=0,d=0;c<s&&d<o;)a=r[c],l=i[d],a<l?c+=2:a>l?d+=2:a==l&&(n+=r[c+1]*i[d+1],c+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n<this.elements.length;n+=2,r++)e[r]=this.elements[n];return e},t.Vector.prototype.toJSON=function(){return this.elements};t.stemmer=function(){var e={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},n={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},r="[^aeiou]",i="[aeiouy]",s=r+"[^aeiouy]*",o=i+"[aeiou]*",a="^("+s+")?"+o+s,l="^("+s+")?"+o+s+"("+o+")?$",c="^("+s+")?"+o+s+o+s,d="^("+s+")?"+i,m=new RegExp(a),p=new RegExp(c),L=new RegExp(l),v=new RegExp(d),b=/^(.+?)(ss|i)es$/,f=/^(.+?)([^s])s$/,y=/^(.+?)eed$/,S=/^(.+?)(ed|ing)$/,w=/.$/,k=/(at|bl|iz)$/,O=new RegExp("([^aeiouylsz])\\1$"),q=new RegExp("^"+s+i+"[^aeiouwxy]$"),F=/^(.+?[^aeiou])y$/,j=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,$=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,N=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,z=/^(.+?)(s|t)(ion)$/,Q=/^(.+?)e$/,W=/ll$/,U=new RegExp("^"+s+i+"[^aeiouwxy]$"),V=function(u){var g,P,T,h,x,_,R;if(u.length<3)return u;if(T=u.substr(0,1),T=="y"&&(u=T.toUpperCase()+u.substr(1)),h=b,x=f,h.test(u)?u=u.replace(h,"$1$2"):x.test(u)&&(u=u.replace(x,"$1$2")),h=y,x=S,h.test(u)){var E=h.exec(u);h=m,h.test(E[1])&&(h=w,u=u.replace(h,""))}else if(x.test(u)){var E=x.exec(u);g=E[1],x=v,x.test(g)&&(u=g,x=k,_=O,R=q,x.test(u)?u=u+"e":_.test(u)?(h=w,u=u.replace(h,"")):R.test(u)&&(u=u+"e"))}if(h=F,h.test(u)){var E=h.exec(u);g=E[1],u=g+"i"}if(h=j,h.test(u)){var E=h.exec(u);g=E[1],P=E[2],h=m,h.test(g)&&(u=g+e[P])}if(h=$,h.test(u)){var E=h.exec(u);g=E[1],P=E[2],h=m,h.test(g)&&(u=g+n[P])}if(h=N,x=z,h.test(u)){var E=h.exec(u);g=E[1],h=p,h.test(g)&&(u=g)}else if(x.test(u)){var E=x.exec(u);g=E[1]+E[2],x=p,x.test(g)&&(u=g)}if(h=Q,h.test(u)){var E=h.exec(u);g=E[1],h=p,x=L,_=U,(h.test(g)||x.test(g)&&!_.test(g))&&(u=g)}return h=W,x=p,h.test(u)&&x.test(u)&&(h=w,u=u.replace(h,"")),T=="y"&&(u=T.toLowerCase()+u.substr(1)),u};return function(M){return M.update(V)}}(),t.Pipeline.registerFunction(t.stemmer,"stemmer");t.generateStopWordFilter=function(e){var n=e.reduce(function(r,i){return r[i]=i,r},{});return function(r){if(r&&n[r.toString()]!==r.toString())return r}},t.stopWordFilter=t.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),t.Pipeline.registerFunction(t.stopWordFilter,"stopWordFilter");t.trimmer=function(e){return e.update(function(n){return n.replace(/^\W+/,"").replace(/\W+$/,"")})},t.Pipeline.registerFunction(t.trimmer,"trimmer");t.TokenSet=function(){this.final=!1,this.edges={},this.id=t.TokenSet._nextId,t.TokenSet._nextId+=1},t.TokenSet._nextId=1,t.TokenSet.fromArray=function(e){for(var n=new t.TokenSet.Builder,r=0,i=e.length;r<i;r++)n.insert(e[r]);return n.finish(),n.root},t.TokenSet.fromClause=function(e){return"editDistance"in e?t.TokenSet.fromFuzzyString(e.term,e.editDistance):t.TokenSet.fromString(e.term)},t.TokenSet.fromFuzzyString=function(e,n){for(var r=new t.TokenSet,i=[{node:r,editsRemaining:n,str:e}];i.length;){var s=i.pop();if(s.str.length>0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i<s;i++){var o=e[i],a=i==s-1;if(o=="*")n.edges[o]=n,n.final=a;else{var l=new t.TokenSet;l.final=a,n.edges[o]=l,n=l}}return r},t.TokenSet.prototype.toArray=function(){for(var e=[],n=[{prefix:"",node:this}];n.length;){var r=n.pop(),i=Object.keys(r.node.edges),s=i.length;r.node.final&&(r.prefix.charAt(0),e.push(r.prefix));for(var o=0;o<s;o++){var a=i[o];n.push({prefix:r.prefix.concat(a),node:r.node.edges[a]})}}return e},t.TokenSet.prototype.toString=function(){if(this._str)return this._str;for(var e=this.final?"1":"0",n=Object.keys(this.edges).sort(),r=n.length,i=0;i<r;i++){var s=n[i],o=this.edges[s];e=e+s+o.id}return e},t.TokenSet.prototype.intersect=function(e){for(var n=new t.TokenSet,r=void 0,i=[{qNode:e,output:n,node:this}];i.length;){r=i.pop();for(var s=Object.keys(r.qNode.edges),o=s.length,a=Object.keys(r.node.edges),l=a.length,c=0;c<o;c++)for(var d=s[c],m=0;m<l;m++){var p=a[m];if(p==d||d=="*"){var L=r.node.edges[p],v=r.qNode.edges[d],b=L.final&&v.final,f=void 0;p in r.output.edges?(f=r.output.edges[p],f.final=f.final||b):(f=new t.TokenSet,f.final=b,r.output.edges[p]=f),i.push({qNode:v,output:f,node:L})}}}return n},t.TokenSet.Builder=function(){this.previousWord="",this.root=new t.TokenSet,this.uncheckedNodes=[],this.minimizedNodes={}},t.TokenSet.Builder.prototype.insert=function(e){var n,r=0;if(e<this.previousWord)throw new Error("Out of order word insertion");for(var i=0;i<e.length&&i<this.previousWord.length&&e[i]==this.previousWord[i];i++)r++;this.minimize(r),this.uncheckedNodes.length==0?n=this.root:n=this.uncheckedNodes[this.uncheckedNodes.length-1].child;for(var i=r;i<e.length;i++){var s=new t.TokenSet,o=e[i];n.edges[o]=s,this.uncheckedNodes.push({parent:n,char:o,child:s}),n=s}n.final=!0,this.previousWord=e},t.TokenSet.Builder.prototype.finish=function(){this.minimize(0)},t.TokenSet.Builder.prototype.minimize=function(e){for(var n=this.uncheckedNodes.length-1;n>=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l<this.fields.length;l++)i[this.fields[l]]=new t.Vector;e.call(n,n);for(var l=0;l<n.clauses.length;l++){var c=n.clauses[l],d=null,m=t.Set.empty;c.usePipeline?d=this.pipeline.runString(c.term,{fields:c.fields}):d=[c.term];for(var p=0;p<d.length;p++){var L=d[p];c.term=L;var v=t.TokenSet.fromClause(c),b=this.tokenSet.intersect(v).toArray();if(b.length===0&&c.presence===t.Query.presence.REQUIRED){for(var f=0;f<c.fields.length;f++){var y=c.fields[f];o[y]=t.Set.empty}break}for(var S=0;S<b.length;S++)for(var w=b[S],k=this.invertedIndex[w],O=k._index,f=0;f<c.fields.length;f++){var y=c.fields[f],q=k[y],F=Object.keys(q),j=w+"/"+y,$=new t.Set(F);if(c.presence==t.Query.presence.REQUIRED&&(m=m.union($),o[y]===void 0&&(o[y]=t.Set.complete)),c.presence==t.Query.presence.PROHIBITED){a[y]===void 0&&(a[y]=t.Set.empty),a[y]=a[y].union($);continue}if(i[y].upsert(O,c.boost,function(Ae,He){return Ae+He}),!s[j]){for(var N=0;N<F.length;N++){var z=F[N],Q=new t.FieldRef(z,y),W=q[z],U;(U=r[Q])===void 0?r[Q]=new t.MatchData(w,y,W):U.add(w,y,W)}s[j]=!0}}}if(c.presence===t.Query.presence.REQUIRED)for(var f=0;f<c.fields.length;f++){var y=c.fields[f];o[y]=o[y].intersect(m)}}for(var V=t.Set.complete,M=t.Set.empty,l=0;l<this.fields.length;l++){var y=this.fields[l];o[y]&&(V=V.intersect(o[y])),a[y]&&(M=M.union(a[y]))}var u=Object.keys(r),g=[],P=Object.create(null);if(n.isNegated()){u=Object.keys(this.fieldVectors);for(var l=0;l<u.length;l++){var Q=u[l],T=t.FieldRef.fromString(Q);r[Q]=new t.MatchData}}for(var l=0;l<u.length;l++){var T=t.FieldRef.fromString(u[l]),h=T.docRef;if(V.contains(h)&&!M.contains(h)){var x=this.fieldVectors[T],_=i[T.fieldName].similarity(x),R;if((R=P[h])!==void 0)R.score+=_,R.matchData.combine(r[T]);else{var E={ref:h,score:_,matchData:r[T]};P[h]=E,g.push(E)}}}return g.sort(function(Me,Re){return Re.score-Me.score})},t.Index.prototype.toJSON=function(){var e=Object.keys(this.invertedIndex).sort().map(function(r){return[r,this.invertedIndex[r]]},this),n=Object.keys(this.fieldVectors).map(function(r){return[r,this.fieldVectors[r].toJSON()]},this);return{version:t.version,fields:this.fields,fieldVectors:n,invertedIndex:e,pipeline:this.pipeline.toJSON()}},t.Index.load=function(e){var n={},r={},i=e.fieldVectors,s=Object.create(null),o=e.invertedIndex,a=new t.TokenSet.Builder,l=t.Pipeline.load(e.pipeline);e.version!=t.version&&t.utils.warn("Version mismatch when loading serialised index. Current version of lunr '"+t.version+"' does not match serialized index '"+e.version+"'");for(var c=0;c<i.length;c++){var d=i[c],m=d[0],p=d[1];r[m]=new t.Vector(p)}for(var c=0;c<o.length;c++){var d=o[c],L=d[0],v=d[1];a.insert(L),s[L]=v}return a.finish(),n.fields=e.fields,n.fieldVectors=r,n.invertedIndex=s,n.tokenSet=a.root,n.pipeline=l,new t.Index(n)};t.Builder=function(){this._ref="id",this._fields=Object.create(null),this._documents=Object.create(null),this.invertedIndex=Object.create(null),this.fieldTermFrequencies={},this.fieldLengths={},this.tokenizer=t.tokenizer,this.pipeline=new t.Pipeline,this.searchPipeline=new t.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},t.Builder.prototype.ref=function(e){this._ref=e},t.Builder.prototype.field=function(e,n){if(/\//.test(e))throw new RangeError("Field '"+e+"' contains illegal character '/'");this._fields[e]=n||{}},t.Builder.prototype.b=function(e){e<0?this._b=0:e>1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s<i.length;s++){var o=i[s],a=this._fields[o].extractor,l=a?a(e):e[o],c=this.tokenizer(l,{fields:[o]}),d=this.pipeline.run(c),m=new t.FieldRef(r,o),p=Object.create(null);this.fieldTermFrequencies[m]=p,this.fieldLengths[m]=0,this.fieldLengths[m]+=d.length;for(var L=0;L<d.length;L++){var v=d[L];if(p[v]==null&&(p[v]=0),p[v]+=1,this.invertedIndex[v]==null){var b=Object.create(null);b._index=this.termIndex,this.termIndex+=1;for(var f=0;f<i.length;f++)b[i[f]]=Object.create(null);this.invertedIndex[v]=b}this.invertedIndex[v][o][r]==null&&(this.invertedIndex[v][o][r]=Object.create(null));for(var y=0;y<this.metadataWhitelist.length;y++){var S=this.metadataWhitelist[y],w=v.metadata[S];this.invertedIndex[v][o][r][S]==null&&(this.invertedIndex[v][o][r][S]=[]),this.invertedIndex[v][o][r][S].push(w)}}}},t.Builder.prototype.calculateAverageFieldLengths=function(){for(var e=Object.keys(this.fieldLengths),n=e.length,r={},i={},s=0;s<n;s++){var o=t.FieldRef.fromString(e[s]),a=o.fieldName;i[a]||(i[a]=0),i[a]+=1,r[a]||(r[a]=0),r[a]+=this.fieldLengths[o]}for(var l=Object.keys(this._fields),s=0;s<l.length;s++){var c=l[s];r[c]=r[c]/i[c]}this.averageFieldLength=r},t.Builder.prototype.createFieldVectors=function(){for(var e={},n=Object.keys(this.fieldTermFrequencies),r=n.length,i=Object.create(null),s=0;s<r;s++){for(var o=t.FieldRef.fromString(n[s]),a=o.fieldName,l=this.fieldLengths[o],c=new t.Vector,d=this.fieldTermFrequencies[o],m=Object.keys(d),p=m.length,L=this._fields[a].boost||1,v=this._documents[o.docRef].boost||1,b=0;b<p;b++){var f=m[b],y=d[f],S=this.invertedIndex[f]._index,w,k,O;i[f]===void 0?(w=t.idf(this.invertedIndex[f],this.documentCount),i[f]=w):w=i[f],k=w*((this._k1+1)*y)/(this._k1*(1-this._b+this._b*(l/this.averageFieldLength[a]))+y),k*=L,k*=v,O=Math.round(k*1e3)/1e3,c.insert(S,O)}e[o]=c}this.fieldVectors=e},t.Builder.prototype.createTokenSet=function(){this.tokenSet=t.TokenSet.fromArray(Object.keys(this.invertedIndex).sort())},t.Builder.prototype.build=function(){return this.calculateAverageFieldLengths(),this.createFieldVectors(),this.createTokenSet(),new t.Index({invertedIndex:this.invertedIndex,fieldVectors:this.fieldVectors,tokenSet:this.tokenSet,fields:Object.keys(this._fields),pipeline:this.searchPipeline})},t.Builder.prototype.use=function(e){var n=Array.prototype.slice.call(arguments,1);n.unshift(this),e.apply(this,n)},t.MatchData=function(e,n,r){for(var i=Object.create(null),s=Object.keys(r||{}),o=0;o<s.length;o++){var a=s[o];i[a]=r[a].slice()}this.metadata=Object.create(null),e!==void 0&&(this.metadata[e]=Object.create(null),this.metadata[e][n]=i)},t.MatchData.prototype.combine=function(e){for(var n=Object.keys(e.metadata),r=0;r<n.length;r++){var i=n[r],s=Object.keys(e.metadata[i]);this.metadata[i]==null&&(this.metadata[i]=Object.create(null));for(var o=0;o<s.length;o++){var a=s[o],l=Object.keys(e.metadata[i][a]);this.metadata[i][a]==null&&(this.metadata[i][a]=Object.create(null));for(var c=0;c<l.length;c++){var d=l[c];this.metadata[i][a][d]==null?this.metadata[i][a][d]=e.metadata[i][a][d]:this.metadata[i][a][d]=this.metadata[i][a][d].concat(e.metadata[i][a][d])}}}},t.MatchData.prototype.add=function(e,n,r){if(!(e in this.metadata)){this.metadata[e]=Object.create(null),this.metadata[e][n]=r;return}if(!(n in this.metadata[e])){this.metadata[e][n]=r;return}for(var i=Object.keys(r),s=0;s<i.length;s++){var o=i[s];o in this.metadata[e][n]?this.metadata[e][n][o]=this.metadata[e][n][o].concat(r[o]):this.metadata[e][n][o]=r[o]}},t.Query=function(e){this.clauses=[],this.allFields=e},t.Query.wildcard=new String("*"),t.Query.wildcard.NONE=0,t.Query.wildcard.LEADING=1,t.Query.wildcard.TRAILING=2,t.Query.presence={OPTIONAL:1,REQUIRED:2,PROHIBITED:3},t.Query.prototype.clause=function(e){return"fields"in e||(e.fields=this.allFields),"boost"in e||(e.boost=1),"usePipeline"in e||(e.usePipeline=!0),"wildcard"in e||(e.wildcard=t.Query.wildcard.NONE),e.wildcard&t.Query.wildcard.LEADING&&e.term.charAt(0)!=t.Query.wildcard&&(e.term="*"+e.term),e.wildcard&t.Query.wildcard.TRAILING&&e.term.slice(-1)!=t.Query.wildcard&&(e.term=""+e.term+"*"),"presence"in e||(e.presence=t.Query.presence.OPTIONAL),this.clauses.push(e),this},t.Query.prototype.isNegated=function(){for(var e=0;e<this.clauses.length;e++)if(this.clauses[e].presence!=t.Query.presence.PROHIBITED)return!1;return!0},t.Query.prototype.term=function(e,n){if(Array.isArray(e))return e.forEach(function(i){this.term(i,t.utils.clone(n))},this),this;var r=n||{};return r.term=e.toString(),this.clause(r),this},t.QueryParseError=function(e,n,r){this.name="QueryParseError",this.message=e,this.start=n,this.end=r},t.QueryParseError.prototype=new Error,t.QueryLexer=function(e){this.lexemes=[],this.str=e,this.length=e.length,this.pos=0,this.start=0,this.escapeCharPositions=[]},t.QueryLexer.prototype.run=function(){for(var e=t.QueryLexer.lexText;e;)e=e(this)},t.QueryLexer.prototype.sliceString=function(){for(var e=[],n=this.start,r=this.pos,i=0;i<this.escapeCharPositions.length;i++)r=this.escapeCharPositions[i],e.push(this.str.slice(n,r)),n=r+1;return e.push(this.str.slice(n,this.pos)),this.escapeCharPositions.length=0,e.join("")},t.QueryLexer.prototype.emit=function(e){this.lexemes.push({type:e,str:this.sliceString(),start:this.start,end:this.pos}),this.start=this.pos},t.QueryLexer.prototype.escapeCharacter=function(){this.escapeCharPositions.push(this.pos-1),this.pos+=1},t.QueryLexer.prototype.next=function(){if(this.pos>=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos<this.length},t.QueryLexer.EOS="EOS",t.QueryLexer.FIELD="FIELD",t.QueryLexer.TERM="TERM",t.QueryLexer.EDIT_DISTANCE="EDIT_DISTANCE",t.QueryLexer.BOOST="BOOST",t.QueryLexer.PRESENCE="PRESENCE",t.QueryLexer.lexField=function(e){return e.backup(),e.emit(t.QueryLexer.FIELD),e.ignore(),t.QueryLexer.lexText},t.QueryLexer.lexTerm=function(e){if(e.width()>1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){ce.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!ze(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function A(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await A(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{fe(e,t)}),fe(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;o<s.length;o++){let a=s[o],l=r.data.rows[Number(a.ref)],c=1;l.name.toLowerCase().startsWith(i.toLowerCase())&&(c*=1+1/(1+Math.abs(l.name.length-i.length))),a.score*=c}if(s.length===0){let o=document.createElement("li");o.classList.add("no-results");let a=document.createElement("span");a.textContent="No results found",o.appendChild(a),e.appendChild(o)}s.sort((o,a)=>a.score-o.score);for(let o=0,a=Math.min(10,s.length);o<a;o++){let l=r.data.rows[Number(s[o].ref)],c=`<svg width="20" height="20" viewBox="0 0 24 24" fill="none" class="tsd-kind-icon"><use href="#icon-${l.kind}"></use></svg>`,d=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=`<span class="parent">
5
+ ${ye(l.parent,i)}.</span>${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Je(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),re(e)}}function ye(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ne(t.substring(s,o)),`<b>${ne(t.substring(o,o+r.length))}</b>`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&amp;","<":"&lt;",">":"&gt;","'":"&#039;",'"':"&quot;"};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var H="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,be=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(be?"is-mobile":"not-mobile");be&&"ontouchstart"in document.documentElement&&(Xe=!0,H="touchstart",Ee="touchmove",B="touchend");document.addEventListener(H,t=>{ie=!0,D=!1;let e=H=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=H=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(H,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var Z=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; }
6
+ `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await A(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='<svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>',ke(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=ee+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',"&quot;");r.innerHTML=`<svg width="20" height="20" viewBox="0 0 24 24" fill="none" class="tsd-kind-icon" aria-label="${i}"><use href="#icon-${t.kind}"></use></svg>`}r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',"&quot;");r.innerHTML=`<svg width="20" height="20" viewBox="0 0 24 24" fill="none" class="tsd-kind-icon" aria-label="${i}"><use href="#icon-folder"></use></svg>`,r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await A(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(_e(e,i,n))}function _e(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=_e(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='<use href="#icon-chevronDown"></use>',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var Oe=document.getElementById("tsd-theme");Oe&&Se(Oe);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})();
7
+ /*! Bundled license information:
8
+
9
+ lunr/lunr.js:
10
+ (**
11
+ * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
12
+ * Copyright (C) 2020 Oliver Nightingale
13
+ * @license MIT
14
+ *)
15
+ (*!
16
+ * lunr.utils
17
+ * Copyright (C) 2020 Oliver Nightingale
18
+ *)
19
+ (*!
20
+ * lunr.Set
21
+ * Copyright (C) 2020 Oliver Nightingale
22
+ *)
23
+ (*!
24
+ * lunr.tokenizer
25
+ * Copyright (C) 2020 Oliver Nightingale
26
+ *)
27
+ (*!
28
+ * lunr.Pipeline
29
+ * Copyright (C) 2020 Oliver Nightingale
30
+ *)
31
+ (*!
32
+ * lunr.Vector
33
+ * Copyright (C) 2020 Oliver Nightingale
34
+ *)
35
+ (*!
36
+ * lunr.stemmer
37
+ * Copyright (C) 2020 Oliver Nightingale
38
+ * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
39
+ *)
40
+ (*!
41
+ * lunr.stopWordFilter
42
+ * Copyright (C) 2020 Oliver Nightingale
43
+ *)
44
+ (*!
45
+ * lunr.trimmer
46
+ * Copyright (C) 2020 Oliver Nightingale
47
+ *)
48
+ (*!
49
+ * lunr.TokenSet
50
+ * Copyright (C) 2020 Oliver Nightingale
51
+ *)
52
+ (*!
53
+ * lunr.Index
54
+ * Copyright (C) 2020 Oliver Nightingale
55
+ *)
56
+ (*!
57
+ * lunr.Builder
58
+ * Copyright (C) 2020 Oliver Nightingale
59
+ *)
60
+ */
assets/navigation.js ADDED
@@ -0,0 +1 @@
 
 
1
+ window.navigationData = "eJzUvWt33DiSNvhfKr92V01b0/XOzDdZl6rckS23JLu3Z04dHogJSWgziWySKZdqz/73PQBvAIhL4Mb0fuhqSWY8TyAiELgD//v//NDh37sf/uuHHS3bH/70Q/lCql2D6x/+63+nf0K7V1SXeGf6Z/JnUnf4uUEdofUPf/rhgLqXHvG4x3XX/sSwixGlkL//8aXbVz/86YevpN798F//cfYf//Hzv/3H//unWS98wPUO1+Xbn0n9T1zCOHRSLqYGo7Ijr/jPh4Y+N2i/J/Wzm0kn5WJqK9r9+QmVHW3e3Azi13rk3wRsdCAGP5V0f6A1IzB88BXVj6j+8yvB38xaHUgxAxWCiKvQFWk7KCz71oVHawyFozV2uqRET0+02r2DYk4CLuRv5A/U7LysKoi4Hf5C6VdjzW3f6vLP4xdmbv5FIXztKlRJq6qvVWB0VcRFUaNX8oy8KFQRt/G6twM2Ga+k1XFf/5l9YuXmGIXwtatkTwRXOyju/LELln2z+zP/HoArfG0y02+Sw0HJw0i8yBlR6SJhqghLExC48VtYgoAg9l+6o7qkdYkPRlf1IdWWL3iPLLQ9RiF+DY9sc3VVgPnHzmBAb/TYQYHFr50O7VCH/7xHNXrGDMuNrkq43fF8JDtjlumT7g51Zlf08sX8pTs71zvC0iCq+hpuNtqAvZRwchzbju6h8OLHziCizf7Pr6giO3uHcsBWPnf28uixs3XsBtThM0hqJPUO/67D4//g0ofUbYeqylhU8d/dWF1Dd0djH1n8dxfWv46k/Np2qNFWiflfIa2SEB97ujtWuP1JUznf6SvIDS0V47yihqDHGWX8QoY7eydosQRhQ5DmCZULlD//RVHrrz8LQHt0eKS/P1dmbcYvLNrwMcOfd7isEBsEvWKTfRYfgix2zh38nh7rUkB+Otb872ZsUU4m+vnfBe2Hz45dJ9oTDM/lnPAXL+TgD86knNDX6NEf+Ro9uoFJ1eEmAJvLOeF/aegxwCZczAm+LUOcyaSc0B9wffSHZlJuaLpDVQA2E3OC37OGfgbH9XHvAuYiSkbU4NJDmLlHSafqD/T5uQqo+72cG74hz88hkT4IugmksRHE8g/LAZI4KbLbfe7K26enFnc+WotyFqXRU4cbUhM/7FHIZo0KN90XaeYAYOpRyKZxvfPStd7ZwJoGvbVeeFzCVnD2wb3orLJCbWtpGEcJGfQv76T6x3rQXqZkAjY1j92Lt3sGGTssvSd/iDXMWfxRxFb+9/gFvRLa3B8f2ZwoHF0RtHI0GO3K5rh/9IoIQcxiGOGrd4Ho74DwcgpSO3l2imUykrp/JSpfsFf96yUsmvMP7huv4B5lLLAXqML1DjW+MS7KWbWuS1wxu/rpPUrZND//eHF1c3VZfLq7/bC9vyru//Hh/e2Nj0cNEBbHXqBm52+qXsZWFlx79it7CRvkC+ouKBsOVpVPmpHlbHmAfelti0HGqrjfuMAxIihfKG3xNfGMwEnKCf3hWHXkUPGPvRKiRtxmFuY3UrLS3pC2u6+oV19EI+4m64ctEXQygI1wWjrwiNRJxhqltKKN/1BWELOrfdx79WVnCXNfls0Howbz/o5XQAlytrDtP7s+VhX/iz/DKOogoa1fnetFrOau265BpPbPO5KkleLgZXP2vQMuJPhGKauFD28P9KIih0cqrS5ALC2JWvU/1t2OfvNUfxCyad9g1OHzb4h4NnySoJPggk9LP6Bnf4pJ1ElySUq/WjRJOaGv5bU+KPb1ctFPA37DV1H80Xs5N3z7gS+hBLh3EgWQ3PsN+AUxCDib7vnU0FeyCyuHBOAk7Eu9+5W08sYRKJ8s76T7RIlvv1MSdBLc0WOHtx3eB0eCigCj/IQatA8PvyWGk/a+RBW+wyGJYBKFkTzwWYBAml7YTYSbV1LiYAPK8m66cFfdwz0UlinuQZniPjZT3Htmilg6L7IvqDpGkEniTrK/k3pHvwWnQEncSvZ2EMLBPVnABSxTA5fMoqT86mehWcqi6w51uCN7r9mqUcai8Q69/bP1w3z7Z2sDxI/eS5KjjK34GB+uK+RVeUcZC+wlrvkQP3CIqxF3kd1j1JQvQUSzqI2EoIo+RxRJI2/zC2k7Upfd5bhpwMtBqrCtXMM3vqM+Uc4K72clu1Hot7qiaPe+QvVXL4OIgjZtG/R82dCDtzEEOSs8PZw3GPnDz3IW+Ku6I52Q1l2TPP33tgme/ouPtLumx3p31TTUY7ZTI2zlYh+w7RM71PgUQhSz4WP24aW0U8xt+UnIZnb2ja9LJyEb8Cuuu6s96TqfSWZRymqP33F5oNRrA8AoY1H6Gu2wrzFGGRssRt2xwT7TgYKIeT5w+Mhb41nMovQT7sqXc36kAIw8ylht0ZUvnpVxlrHFBP/K3xaDkE1lNmni5bxRwOI6NqvvrewoZHMbb6SDWl5F1ErStF5NIxewAVao857WnoRswLTZo+58z2YevbAFOSf8fefVtZ+EnMAPntPws5QNuqH7928dbs+8FtIFMQf4B8ri575De6/1OkXUQfJA9jiIYhK0EDzj7vwVEb7SfK1sc3azLKXtVFcV301+3dD9//2JkfhxqeIOMpZGP+C2Rc9ewzFF1E7Sl1rJ8iAOQRJA8YWNTP0qtiLqImEZ8cI3eciSdopfcI1b0nqHsiJqJ9nWpCOo8u1AypIuCr4RP6i2SLJ2mg94RxDbhuCZGRVRB0lYApMl7RTT9LUnwSQHgO8nqkMIekk7RVACFuXs8DyVsZw2pDdPFlXcQvZLQ7xW0tj3Djjfjt0oY4F9QV6efEE2971g9OrV1eICFsDFrCwHMsJpZ2Hf/dt//p+//FWcNvy121e+phxlLMpu+33D57udPA9m11mWcqm+nc4OBHAMUlAO5ewBjEJz8MDIsJwyBHHoZwqNLGzbfwDLKAZkWWxgB5Fod6/rONR9Cy503XYFDe57eSeHA/X9cvOGCbPfduSH3MvA8C+JsjYEIRiEYAxyIwqBXzafJuw7+s0P+o5+AyDv3u7oN69QF2Tc+MJ25HNl65yLZiHqxXZ7CGbrRX3YwsmgXHyjlZ+bJhEn+rhP2it8RSEwwx3+1xG38EIocmCeB2krLZDkYbGTVsvQb5T2jGZZDMxye8ANCiKaJN1cL7j8+kh/v8BV5RVhqiCM6T393Z9lEAIw6HYeOxlM+421DGxDtCf+KOJGn7YLn+/Qwaf1XkhCuHyaW2BLe0H3j9TPPKMEBHtPa/84lcQgLIcKd54+FoQADGIHanEEXAu/6ERJ58G3bIuGl8KjgFNZtgXUD3kQcCL365q+gS5JOTmefMZr2yfbSG1YqgIrOnzvVHH4TjlXDQPXnKrWMcgbdF3Qy325Jkx1oRyCrFssN+EPW0X9CAYhAEPlV2VGAQiydnOLG9+4p0XDwiZqPHshswgI3bOFmEWc6L9itPMddwgyTnxxFhdMIAq5GTq8b730nySc2Deo7RcTP6FnUqOONur0qYPKBOBmJrVfnRgFAMht5xmtswgMXdwfAIFW9waYcYP9oBUHsconDAE8yyOGBmT/MYUkBeK4o74DJEnKybFHz95bTSYhWyP/AbVs3wHuEKk8R/VLUWcx2HyhX7s/SYCwfUswiQDQu4YqqkM6srOctTvLP+PLPwHwXM4OL1/YAkJeXtayBMWVb29WFHIavX5iF3X4B74gZ4n9/oZaH+Bewladbmvsk5b7z5126D/7FdW7CvumZI0shO/T8bEi5aeGHryoBDE3y5hhvTuOC0kAl1diACaF22NXYQ+1+edAVKXKgqB1ddaK7+lfRRDIFEICw/9EW357YuBKmV7czcpunMatX2dYFHIy3KEd8ZtTmiQA2OyCRU/wUcSNTr/JG10gTc0gZGtsSPsetbgitde+qVnK1gxMH13T5o76HTtYCIOI7gmbPAvj6WVtbdD9eEW2Z49UkXP6evrer0cni8FZPFO4IgfneRDvKYSSPKj3FFoYzgL9cubpl7Mwv5z5+eUs0C9nnn45C/HLmY9fAgsCLQc/KyavOEKS4yxn7YzrTrG5CmA4vaZVnh8d9oDm37twSStOQfnukFxKW7OidD4bZPnFoWzV5hXbKeFn80nEbZvbR+/xySBjbYTYgMB3t/8sZTXxN9KpIe6yxyTijkH+qZ+1JxEn+gN6bP263JMEHNuvJyyLgVg8BySziAe6fyF8uvTs+/sOw5utUcBZnzo2ZsRBh3NUWVv96j+9IX5ndAQxN/inhu6J3zVOsqSb4nNN/G5HEuVsOYKdj/Gqw6OAO3J8tsCAtr7w3dJeug4CbuQGeyIPAiBkNu/1ke48rCEIuRneDuzFpcPLm18JJDEnyxfNQwQOhi+Gxwh06KQlj6Qi3VvAlK4ibO0i/J0/HeLXsAgyzoII3/rlZVUQyOTZwIhCXgwhhfFpZnoJr4ZmFnGi/wO3H/3mbyYJF/Y/KfHKy+x7Sz7+b/4okO8E+yxlgb45v/vlqrjf/s9VcXf1t89X9w8zhftWk6W0TCVdcVIhv9aWfW/T3LPxdrTa7Kmkd8+eB10mIYee08EIX4UnQRCB5+MNkiCIwPe1AlnSQXGJn9Cx4t0Ir6t1VFlLCLJPh0UWaKUXRFy1XviULXuDM6Mq58EzrOF7NMBaYQ/GO9weK3DKXAh6MN3TpuMLkQFkkyyEj0XNtfrgJCy4BVFHdLPLDryrPxeyAVO0w96Xk8xStnxI0e6+bMjBL2dPUlbo0ut6H/a9BW6PSM3vHPbBnISswF/9bxGdhBzA/jeIzlIW6A/I67TpB2Q7ZLpHh6CRuChn0/X8/uHqrri8ejjf3hS/Xp1fXt35JH6dvCX5y5/f3d56dXWW0jYqYdONnztmOauT588+SENIQDkUWUsp9qgrva5a4AK2eMJ76nkB5yBiMwbbXOObAichGzAbdoXfCKcRd5EN93GGXBepk3fRBfPACMSG23V/kaatlq8uYh80degV/ktpi+o1uyKmIn9g37tlJEELwUd633rc7cQ/t9mm9jNGbS095WsTXul+ELGA3j62uHn1ueZslLCVmz62lJ1u8dO1l7Ep+/TElvB9U4ogZgP32xtxa90UQYflnm1dVsed3xMaqqxdZ/+L+CchO/AFrZ/Is0dcjCK2wLitcehgUhG1tI63NfYcSs4SrlHJbY19H8EbROzWDhzpyJJ2Cu9xzihji/MDrr0vBZ2EbPryLYo+F+2NEta85NWiWocgt90LuyNpcXgRYFZJ0kWhOTcCpDCcH5Ep+Jyvd0KdpCzQh34OI2zFcCFsIfqEDupI251NJiFLHjmgpsXnbUmI/21EqqzVUE2L2fa0n//9/2r9Uosi6iLhG90/N14DH0nQRkDKr/wJx2vwhJcg4kq77FPeujR7P/xJCMLAzrj6wfcSIOygaiAKOozP+s9+yvcSEOVva0+7cAEgMm9jvOEHKQgHW7U/eNpmlIHgs2VrP/RewoX9idTPvql5lLHlS9p0SLmbytW4zjK25vXQYH6LrleIDzK26G4wu1r5fUO/tbgZ7t+6/0YO+BfcslPNfnXKiWZVhW8AUd5YhpDOcm54/rZEADyXs8Oz2QFPZCZiAf3XER/9+pW9hAWyQfWO7u+7htReb1yJcjZ4VfAn/kpbzZLsTywp/tQcpWcPXa/bL/5SzIAFAyw4oFLf//RD+UKqXYPrH/7rfyfldrguhxcY7o6V1wQiVA2FYtED+k2w1d3Vxe3dZfHx6svVXfHl/ObzlY9GS2lLd+sOl9T/IdJZyurxZ8ImVx+8+v+zlBWarax88ryRdpayQN/xj/wS9SxjS9QN3tNXfPV716D7A9ut46e7Imy1Dvv2/vjY+ldmWdRJEvRSuiJqJTlUqAwtiixrpWlp9Ro2aFJlrTSd30QDF7DG6itWOxWQyjtK2aAp8cbtRWwGYA9XPJDyq5+FJymrvsdu+cqYs+IKUraqe0e/bcFXVPCPXd3M8SCGjyFGGYsZprM9Ibi2a9qnwykhwGcW4DbkubsW8NBdq3vizt16tqbH7c4U91XeU+KTkNXO7Lns890/j37buUQ5J/yD/5s/kqCTIAzdBc2P/ijbUgHYs5gT3FvvScoKXTb+032zlBV6uE5OXva2PzYiCcngYs5rcUP48l3gZJxO3lZdDQ9FulJ4a3kgUk7i9y/Yr5/CBWwqk/q5ws3Ra/ZwEnICty9+88+zlBO6I35bjmYpWzCSP4KedhTlbJpXGHtt5uECNn0/nN/cBO/1XUrbmosa8dktf9uIgray0GMjHnV01Zr+e2ttOZC69lS2F7Gp+a8jarzGbL2ELSx45548vYVN5mvEbfofleONTjsfNWcbFUP3n7wn9U4a4QChBzkrAz9R6GV1LmExBDvA5tuijTJW2PYr3ALsa1u5H97jF/RKaLNwm70Dr8q5+vIPF8empc10gRiYR5Fz8XR4f6j4k7te1VIQs5meXQzI9gmDtR8FnOYhftdGLI+5yYqSCo+XGvvCjnIOeJ/e1Pi9uSPF3s713Ns6iNjU3H64uv38UNz/48P72xufhkuWtDRabL3E/xniWcqmfb+fiSkKDrdZxBlwy/1VIGz3RpSOBryDNglZDcKnwvxTiCLnLkDISfpZylKEjoasdM9SVujPXXnpufozCdnM7m9wsKkfGlS3laS0s0EbRayt2nDu1atSDjI2GzdHXPlFBZewQr6VvnumRxmb03ybc2Az3nV+kdvZQrZfKfe52XaWcCr6dqA+GZ99b8nzR/5YtE/RewlL6Y8tPh+nGPxma2RJMIX3NjuNOISMj8cekVeLuBB2Eh1RdYGq6hH5jdIXwhCiO+x1+7ooB4H3XrSXJSEU3gv3sqSDgm2V8gVnMg7Y6XZLX+xJ0EmgadugFIZGbkEi3V7tSyMJO4jat7pUbyCDscySAIrxwsMQklEWQBMUsZOgg+C4I/RThd78Q2uWtFMYh9UgGuvgWqW6QOUL3oWGmCLtoHpBtd9+gkkIAnyJK79OtywJoQjzhyTroJmer/HlmASdBMd9rR6CgFJMoi4SvjvVG59LOaHbrkHE7/VRSdBJwH7xvXhAlnRQmCazYDS2KS2VyndIN4g4QPEjPdalN/AgBgPfBfbPFvIuOnyIqdsLeTvd8PTtveehVFnSQaE8RgND17xGowIPb+34joxlSQeF50TmIOIG9Z5KF+Uc8LQp8efDzr+mCZJ2Ct0TNyAG00M3OgLlbiUwvuZmJR38tCYeQDHJ2mnGTc9sWKO7pwTEpwexE7MjSSHj8EnODs+esQkujyzsIPK84WgQcYMGBa/p3RsdQd8PvaPffCNYFgYQyffswDmW9+zo4C8beui3MIeQCNJuqqsd8e98zIJugi27NK/tK+4FrWv/xtWA4kfNfschsbcE8SO+72jjuX/ajOKm5olEXl4EE06ybppP6M17MlOSBFAEtESTnBu+30segN8LuglCmzpJ1oMmZAZwCQAgZJ8Fp3JB2k31QJ+fq+VxdzCZJO+m+3xocdMtdsaB6SR5Bx0tURVYMEEUQtL3ZIJIelE7yfDAZD8e9WSRZB00eEfQMLb2ZRFEAST3XYPR/v2RVJ57yLQADsKA7iKgqyjeyhOCDgph5aodKLp6344Ka1ygBxFYl+kXVP6zF7fOmQvPm1Z6CSek91YCQcwJHlatZkEnwTDy923NBUknxbY++G39EcSc4AHTgIOUEzqsIzULugkCulGjmBOcvyzlD87FnOAhHZpRzAkespANuDKGfXXA9XhKzZdAEHWQ6J6Bg3GYHoNTKT5Rft+5J/wg5YDuT6kHdSIlWRjNsaNPpPI1lCINorrB6NU3ZEVREMlH9Eqe/auGIu2iYjdEeDMwITvw3464eQuexlKknVRHHDZjKoraSfrR4ENDnv37WpKsi6be4ebviPjXSFHURfKvI267wL03irSDim1GlB8DgpGMcgB4/6NUsqSdIvCUnCwJpghprlRxCFmQzURRCElIwy5IOijGc19BFV+RhlD5Hh+TBCEEnjcginIueO/1R/fCI6//vqi1c4WWeZ6UYTMmkqyDJmj5F7ToO3wUsidJFHWStPwe9IDQF0TtJJrn0EAMhkfRFvBk72sgJmIH/dzi5vzZv0s+ydnh52d/ApaYZWE70d/Zpu1+q4FvmhZFHSSk3tFvAelhFnQRaF4+AjIY3j+SKL5s7x4+n98UX7ZXfy8uft3eXPrs415KW3Z1Sx/73u6+ELYRkYbtpWUTze/FE1kAFknSTeEbwoKYzSfBVQRcP74h0l3T5gP1G4QJYm7wj54zZYKYG/yT/x1msqSFgo0AfC0/ytg0x48tLb/i5bqJOzBVWUto9vWeTTgiUvuxKKJOkmGE7NmCqrI2T/BPvX0xSdm8QZvdNfXbdDnKWGDRgfxguNGNtB2py05zp5PjYrkCHUixEJeVMF4jx6/KTkG1mbF6yn//y3/++9m/iYXPUsTN+OedgCprIN5U98T3cwRqoAjnM7GOCGDg5IXb9H+Emdb89iuE3v76a0rjapkA1s1Qvs3wVy8Dy9vKPLiXm8symHUigVs0vkCjHaseyWnCxdu+HqTa130zGFLkgdsyVclGix4mPKdRldeMPYg17xlnMOjMAjdnijKNpjwOWGZD6t/rgpCaX+xKacgFC8CQCcu02aMDLFNaXhWAMDveFUhpUj0VwK5ZirgZ/ww0s/7GehC/+c76pOZd0EBMm7JYG/YnmDnNt7pCqO33uqY0qpYJYNcM5dsMf7UZWDTxfNU1nHyWAZn0/OLi6tNDcXl1ff75xmcSSySSQSwj7emBYc/HXyQyEcMyeO2/e68cVvM03wZxlOnIm+Qtg0UjeQsRQPoF5tC89FaDiKNn36oK18BUdaW+Cdtx+NO5bod0qCIcshAgPdyRVYXBJe3Akd0jBi3MbvltWSuVB94Ca+WIAq+VwbyFCCD94lMrc9FbDZI2BkwaQGolOpCfzPvAQnVhza19h1iq7oS3BoBuxor22BxbPLwUg0Yud11lh9dia2rZY4DraShnMYsLP3rU0AzEFhMkrZlabp+kfI0eY/38xCHAbg5kLCbp+ScPH6dmNZc9qX81xJ7eje50DxjOTnd/DDU6mEYUeDwF8xYigPSLT2DlorcaJG2QmTQAd7oNC4bbtCbq+6Bbb0cls5BJAUCLv5IpNsQaNb+ZNFJOjiRUS3O45ARumrXw9ZViGX7i4Yk9FpVOLae9/vozz+7L/P5LQ4/R/bTnAQSccYNZC0Fe/Nkj3ebhtlkiaao10INjksvEVlaDEkQwwmGgcHcx5EfEwyKQlH4j+lDOYhYXfvSIvgzEFhMkjTwtt09fkp/oj+1MjiDO3qR8DDMsrPY9BjisQjmLWVz40SOsMhBbTJA0rLTc4HTGRGKzmVYDMhcfnsqYeHSEjyDuCJd3RAeG+AACj/FQ1kKQF3/2CfMs3DZLpA11PT082JlMdLTrlSCCEfQBP6tzc373y5XhjaZU+lSoecZFS/7ARdOfFbQoZHs0KpVC7R5VlV2h3+QJ2pQxa7uBPdtoyEgNCVn1cGBCdnIYsS3T45mtz2bFYXnDeid+NoW6gcfdaN1N0RwyQv1RAlkOO1W24DVNn0XLkYoeUgwu2o4efAcYMdyFDKH86rV+nFUJh3mSNp1WPXwGIf0tX7Eh0Y0o4IAI5y1EAOkXj1DIRm81SNIQMGrg5X717oVA/08w8AAIZy4kBPk3nxjIqIHdLmnjwKxEouWGdIaSZmx9PJbOTEYV4OOOFewxjj9MAaRZdxjEY8dDNtXWXHqA6eHttASrD27N3FbTLUCwB3nkc43eyZhBvPYQkEQcw1hM0vNPsOSbhdVc9lTJ1kQMbG7ZyzgRnh3EIV4NZSq4ZP9fmCeTMenLl8pzKhkkZwyPJYWmUpWS8AKCZk7ZA0dpRqILJOtwlH3Nr2C9wyVtpOtbHU9CLkglGJlUfiby/Ni9RKa8Y/fikfEi+IpRePoBVknSUxoLnarC6FmBie7YUXaHScyY4tjRdoCAOTWcsZik55+gfs3Aai57Ot/qiSFJcZSISIwmejIV3DXbvr1g3oiZTjXqwP1smEyVo/w93b31j3nNKnBqSJDPwkqkLR5RZV/e0W8Ra2gCgmUB7X2D0a5sjvvH8DNSm0cJBFBxI1kLQV78GVR9c3LbLJGoGlvpYYlaEHuXxOnvvL0exCuW9530i6/jc9BbDZLe+ToNYmd9RES2PBOvYz9SVnG93ZVdGcl5Xc+W3YE2fSCu3IqifXc/lVIa6OyzPx5qQPos6xtnQ8QoMh4RMuh4e8im463mdsoTOFBQw9eB6xhHdiA9GBxobk3lPIXr4x7WVbPmR3HY3B9Ri+kVTgCWTuEFqnC9Q03cAL0cUOCD9FjeQgSQfgHFfmZ6q0EStS8ODaKXhUZI+Q7yUAWH2iiCZk9SIAUg6WkdU2zIGDWk57G0JqPwYvYwkVL6ucR1XSTq4OOlNWwy+wqyL26CeCCB+xFsej0sXvZd2VGTAj5eymuK2T8d0WzR0DqHAYZPetnUmpBP6iZZCx9faSzjt6YKU8tpL82C6sXinlj/vkuz8+m3hPMVo/D0A7CvkpzSWOhkfRMta4I+SQ8XMcibVJvCUIRcoYI66WE1cw1DsCzaxwlkhDsC3B7YrYip1ZpQT+YiWQMfL61hkdlXVGADuCumydMrtlZT52L3cVFk82ZTxWoX3qQJ+rDRwCXqUBKTjGCr+0IihrghX7E3hI2mdj22fXrnAtdRd3GUozykHxHMVfSiw//BehApyQzFTNVzWPLBVrouXlDHXjBoaFVFOfEFdaWIYyolI4zseb4gj418MXzFKDz9AIub9JTGQqeKHz0rpOf5gqsDblpD39O2dSpEv4GtcO2lMu5MWVWdDWJ/37O/NzNfVge6NIK4ND4pLPWRMcH1aAU14LkrqYN0msBytm2sZ9gdGaKoeAunz8TmCioMR0jcp32TeMyoBaQujWLtgdY+7xC4FekRvVyiKuHZX7fqYVVL2k6bwSkCKcwrlp3EEdq4dhVbGqW1lOmbpFPUH4M+3u5KWJOWsP4OS1unNBq5tcxWuwzM4E5ExKYERZUZDdx1UMmjHCPwG1XJ5QaFEGb9Y9vRffKkooGF+WNddTYl/4cTZDmjRv5OS5fndLgBbkua6bQ6ARTNVslM1CDPXZMKJ4/uBWj+CUmIAoCJyRXNwZ7kw/aKbnJUugq2RD2lqyDBC7NIVA3XqOS0kzKv/wG3LXpO4qIBam2/iLQAZywKHOWBkVxfdr2t2ZSE9Jp5dNkHxBNZXmSHO2BhBegBJocWVpMMR5wkpxyrjtzjCpdd8nxqwl7dUTY9IC47lY02e/avLf9XeAukgUzXEBnBvwOn+jVLADPF5UajglAbKvnztu6/vnhB9XPgvW2Kjgrk2j7U0QM8ZzRElL9UZey2Mfhm9GRS70ygp/KPrICHhzTmSOKjWSGXjRZ+GhrINmktUkDX95NOAZCfjOaI9JOqkMtGip8ytbbfQWckoh+yslE2vh2PXH2O76G7EdPTyNjJ0Krl37V4wL+nj6sF6No+0ysAcNiK5tgwSngVE0HSVbAl6ild5Ve5bBaJqloalZx20h2EeMHl10f6+wWuqohDoyqM7ego+/Q9/T2WbYCwMf26vbksrm6uPlx9DLrlfNweQ6pdgSu872dEzDv7Yp5xhD/gGPyCIn+/EPxcYyIabcGSLWFITNAdn+QQ+byKCGGNdEpbHMUzAthY2AVspNQXyzsKezDms4q0XduDGSO+/7p/SysZef+cGoSeVrSJfei4ZCA+7xxHshaCvPgzrE5m5LZZIlV9tdEDay/dP9KYKjXK22oU3e9pzZqy4Gu8VAj9TLeOMq5sAoi9gIcKd1GpSYCwMtVt1yBSx+55n3A8dr5HcxcyhPIrsMauoITDPMlqr1MPyFaBY4tn0RSKSID5RwYuctiL5LlNwJ44KUUOe1I9vMXUTS4NqpFhPAUT5P8B1rkkNNqCJatLEhO07Tu8xXd3Dm9+vZ0YzmIWF34EOzELscUECZ1r4IY6+lh3O/otys8zBMjNEYzFJD3/BPRxDlZz2ZP510AMOTg8SkScnzbRk6ngkMvEywajDl8TXAWtMg2m5iBPA4ip1P1XN+iNHmOGhxylGlGMo0LbVlu/W9Ldu32l3ZiXKKpLPYpbutOXuG5xquH2joGBB9uc+h6jpnxJQNtyIBclQRV9TlZcjgYvLyljpohGcZszaXlkU4pxI6PdgAIfF8XyFiKA9Ev2zredGZB/M5fd6g0l/15GBfMydk3ODrV0x/63gkdnHpD/UtBoKr7imwY9Xzb0EFk1G/S8a+jBo2pG8hYigPQL7FzXxcXVp4fi8ur6/PNN2LuwdgU2qCzxoSvcjo6KKbsOgCjL6wZrYCwikR7OG4xiI5EeUIORTyTG8RYigPRL/pRiZQa5P2vZrd4QxwqjZPhQwaEIGTWBjBeumoY27+mR3bQXMVuEGczjDAOIxWjmQkKQf8seji5uQEDmN4DdLbpIiEtInA6ejaIYi0l6/mkdr2s4od5OXlizyRXvXqMdjnPuE9phuG9nacOVHpe9xZheQRYZCyQlxhkzeyhA+CGtks4MPmNSpyJGo/z874sIYSd4EKkDr6XRaSKhnsQpSw0gxwf1xoh2jKyMxTjSnMJW+jDqdkK3Uhoy2/TY/cXd7c1N8WV79ffi4fzul6u7WbVX1BD0mMx3SypZsbN3CZPerM/4w3rRKzECozVxOY3pXjUxRt2xwaEP9QxcPUhnf39noIpsxXoQeEMWyVoI8uLP+YPJwgsJqYzFtjlBvoSP0q/tT8cWp9SGgxYy6KreMCoA22Owii3YRgOol2wXt0WmB0nZ4fz9jLiq1/Ts8JqU0QTW/CldKDxIJtJjhDuBHyRqyAptxpJvyNME7rb9Lw09hu3ANqvBMU/ohZnfwxV5DTE55XmgcXvmS9T952alvqx2CzpUBw8vaYziOeAA6OSylOaEyzXuysiHxJ8YRMiMxk93+BWjKtBFg97iH3u8FcLDzg0Ji/7zmGri0IE0/BfXm9AZXbBpRmxzzogKP0GD6acVnS9zgnowOQprrn9yGhpk3qMWpwg7RQkyafGIWux8iXySvn38Jy67rApRTgFXKasycDUejocqr6c6xgBZ3LJc2Oa3Zcx1Z500I8Y+jthjNIpb5gPZJ21k48cg4I0fOhA2Dv/EUmPdfUSv5Bl1gb3pUfkCHUixBM2fCSEKwMbiq9mDjccP/d/rmczSPsVEiKDS9NOKXpE5gXf9pS+suYpIaW+Uich4JgXIpIEp2ckTQ4nMIEKt6PYFLXA6LFep+RSYMQQWDY12N6tv4hdALOn/l4ZEbO5+7qVhSd8wrcdOJh2bljaf0DOpUUfDFgxZQcasp+BlDzwXN/DA1wpW4Ie++N8PAo81FTDIiNcARY1mqFVdotDCvJGv2MwHrOIAnj4chPv7cFKpMqGt7gSZGe6HnOUfvdEKHFaH3D49tbhLV00VvFWdouOGuWUNKzDXUP53W7L6LUFr1qvC/rOO+ScmgLETlUnbVutXSJlMeBeU006LgRPWOoY18ALNzAU+NfSV7IJ36pjUWOBbOmVZfTAmPPc4wLYYe0n2uG6jUnI/gz8BrRMgOlLI1rplcTljMK+p2JobrrfqHSNhZd5q7xnJamaREnb0NXVB2YnXAdOyaJeirzdwr93F1dNCjJ2v0BsC7N5uE2Q5QYUV2xktK9TqOUrc29yd0+/ot+DnkAX2AWZNY4uUAEtnKOimod8M7z0L1zne0ya6rBxkTePOhJAbK9MWcdO1Pd6yZ6/27ePWKVgNCVqjZ++AB5dXXR1mYCDXyqzenVAt75Jc6njGRpOxrKDWHzVqavTbHmLUYIbWbQZJE2Iz+/jDKvV3yQgc6yQup7FyKbX4V4x2wXfmzcL6XrNMc0e/RcygCwiWCvNrt6/ikhL7DzwpxfAVo/D0Q/YI1TMCIjRDOY2WViJ02/dkz3c7OXr8VvllFNsS//DlNXpMwDegQPj4ClEsHQcBsPHNlDHJ/ccFEIB1uYgWxKlfRtMyfsD1MUUxJxwgZ4JSjjAQRrpb7NsL45yAAKwPDXl+jg7ZAcXO177VZWT5Jgg707Gj9+SPuIN4PyowVsb3VOpWehJxaTd+cAsvirvaePHbLStGLW7iDCmYjOUu5iVRZop9G3/yyGB2E4yxb8zpth3exxWQIbiLdUe/xdHcUbVrobLs3ha9M2+iCcPO1WC0K5vj/rF9p053+VIuoMDMUS9t/6iBsjPz+yTjzDtBWJkuUIXZhRBRoSmCgNgid2CqOCDOB1KFPszxowTiYGv4mCoyUmUYECMzvjxhFsg5AoFYbw+YQSUo6oRk5zU+ZuJLa33ORMe6eNAkhFH7pMmCjVS7T6hB+/AOhYDh4tK8KeFPZngsY8G2fC7Dm0v/YIbKtHxEwJdI/4zAkkd7q78/mfFe/yWj5mZ/fz7D3f4LtrCZ02nxrrHdGmu8K9e7OCKMtUDLG1w9ufR3uKosi6tFfVm0l4uqLPrbw3ypRBQr31NEJDzB5sfCOIrtU7F9yj4bNrNApsNjS6KxmQi/fQpfhhRJyBPk9MzyzLRnlOmPh8vxpT8MHEakOwatsplPk3lzqlAwZu3BMfhYW4fjHHSbjogF0HoS6g6DBbDOMG7qxekrX8dqz1+p7jQc+wjgak1mXTBqjxj4MxoPGSiMus0mnmzGnTVLJnX6KYBJOwW1ZIpzmWnTisyjXcvyZDKuZilci1bBk2eQt3N0eN9GlWZCsPLckDqu9o4AVpY9esZxK4CEQcCXAKMYi0l6/il/v8fACekFZSms2eRqt+UDajvcXOIOkSpyDm8JZY2rD7hraPC9JmMxGYj+1hKV6o4eww6dilTNAGKkqp9ITbrYCjOgeNSZSN5CBJB+yV95rMyQKpS37FZvqNVpmqSL7nsskKyV6fbYVTiCjIsDGPh6ZkjvVBB39kqFb4N7wyoGkDSucyBgWG35CR1wE98hlmEcjFGzpYCJ0k8sD+M2rt8jgljZ7tCOxE1fTggOno7Uz5FEI4SdSXdXkC/VjGHjIi0bhlekjmkO28cZw5SZZ6Jr2tzRmNdeZr4n2jTU+m7RTHtP2DRuCtZ2RDK2Qvclenqi1S52EVbBsQbN9G3clJAM48EYvStBDwfTILK7quD4cKYrtowH0+EBPcYTP6BHMFu64gpgIPazRHXpzKMunaWpS2fwunSWti6d+dels0R16cyjLp0lrktnAXXpLEVdOoPWpbOUdenMty4lcrGHh+M6MxKKnY+/pCjv0PFv6TkI6UHMjTz/KsH2UBUIUMCoXugMYWeq2Ea9OKYJws70jXSq03yZJggAU6S7ZgwAV5z9Jggr0wN6bINH45Owc1g8fRk8EpcRQISRsxkzhNOC2lG/X9nMg3594e47HN67GAGsBVsuP3gdDDIsPsiPrDzg3+Pmt0YAu4ti9iQ69yKyD+LSwoTg4NnHrdOMAHaWBtVthTr2BswTeQ4nk3EcnDiyZAOAk4VNc32ku4hoEEDsbG8H+tygw8tbXMkkGCvjF9J0R1TFTwiqQA7WljySinRvsYswrxOScyXm7+QP1OyC2y1B3JlrhW+D87uKASSNbL9EEKsLxQ8jy+jTivUSUe3YDGEt4D9w+zFumndCsPH8N6ofUR23ZveVY8BX7OI4i1lc+DH7Wp2ZFbBOl63EFtuDr3tSj42FKTbcXKI7RJbVGQteyLJpnhIPR76sjtCfoYtXYKULoNzsYPNntcHgCsMFUdBzhvlUIjOXK1YiDiKatBogTxUtIj04XDKbwXFcc+mW0Dk3kzKauZzVHDJxg72RrfSDH7STkUsnSKdZ47VYnm1dzQUjNdgDmYo+2L+h9v7EdoYJP2qwVEVBPYEzdBpAfGK0h981R26FHDbSPIF1w57ALe63/3NV3F397fPV/UN4V79CzTMuWvIHLprpoK7JKMtNul6Tcfotuj/LDG3ExoqKLNUPuOH+/EDi7kpmpRjvShbBsoe/lRgS9aJQ1D4rsyoaDtt4Nrs/2BW76EDAV+yfNw16S6iPBLduhCypQTEiiSWMElkdLY8rUrL7hkcL+zM4Xi5Q+YJ36ZRS8FaNGB038L2MFazA38vgfwc751fSdrR5u+9Qhwew0Dt2Re30sKu6yqIC5Artq+vzzzcPxd8+X939Y9blFTUEPabTRqKRzXP27tSeYuH00v9zy/75ILJao+oGtV1CHWW4VaNIQw1pIrg5U7QJCn8P7GgE8lufRUaF2s4jIkjbRdzfLekzQa0bCTItLOvnKzZ3AWk72Ls8/NxJ1Ls0qirrvctjZ4b7IWf5R2+A3+X52xE3bwkrqYK3qlN03CdoYlU1PNrWNbzBQuRf7O/WpCmGScnvyTEM0y8q1Lak1F9p5Kt2z1RoMEGBtKYum7L/h/KFHHiNq6zHR6Jj3KWOKc5FRw7CposM4lSy3mtg9ddq+ow+e+L/tL7XdCpB/HaJa/42ZkoraTDXSdYOfkjCXtEcmx37B3DArKTa9+i9/x94NM7Lvy3rpG4PfYy6xg31K3hT4YZ6LbMJes/05yggdS+fOt+Th75Tj4V5UKlXBFX0OXUu0ICu6z+TAqBX9Na0yGbH/8WZC2f9+E7WxOppMFf1l4kf4K41zbHZs3/w8xVu6qQDpCXk2p7S0cMctZItmJtwU1uHiosh94BvGHZbx+TzFN35Lmwz5lio8fehfBLwam52KgFw9oom2czToWhn37M6C1+LZ4ZTanW9OEd8AkeNSng5KrtJBEc9cS6Io9iDL3nUYsind9WkhZevVrCK4K19z2ZLoCz3XqOSrRkm0UvAW91HKjfAM8MXTDJsByFUh3ZgMK9AzoIXtOZ/jVmONKikobEtTrKvF9r4T/gblBHQLdP9uSN0w1zzNBGYHDQj/CS+ziD9klo/8c8ij/QLbAZZq6XXq5/RepqVTvZKaBJbgl4TFYSitttGa7xURbcfF5hoEpnanWVWbQyM+oB2hpzOXBsipKZyIjf3vrTpOpGSxmS9si9VPU7cyBv1cTX4a/qKN3HQAMrU1n4vPcOQXuKaZrF2R9SDFS+UfjXNfEx7Tu/ot4iw5xSFBAbrcUyff2qocnDOv9+h02LJkLNXYbKDz27iPJ6YdxE3Pb59d/cLCTwspSjBcIB9T3JIHAScW8Jdx/VTmYFeT25r7usB1e5mfshXvY0mXAMBbp3sbaYG2j6zAbgn+B/LkcPqEPaQVb8ykSIiBLSV3aEyw7yRt/TMF7uGHp4mBqsrelH5OcpgXWawlR2hEAP8MEskzcaCIksGS17O7AkWFH1A7Hp8a0zwqxfa2P3Gky4iHCguRIGk3pE00bHYPSRKXNC6xmWK2F2YhzmLCH8sJypLUhFRGD7O4jlVtWpkAmp239EGPQfdg+6rWjtRWWOdr5Lf0yaFJyeslbOfzAvdbsAEktauWY0Fvr1e5fMBCwq+3aHt0a2hkGIP/aTH2scZTMSAaJglkoaDoMiSwR4QOT3BQgJ+9OsTeqsoilj8F9TgSKtHw8wKCgX+eeI46FVQsF0RkMPuve9HZLvjg+9RUehXuTnFxAlxeUMPaf3N2UVYh6uTW5q72fBUrkR9hxMFWQ+0spsFUtjAM0dxma0bDKlR/RbfBOw90MrGFkghk+T866TValBARrbXrBwWZ/5uR1yHv6OPrAoKrHpg18ALWiIdJfo6coeFx8UDVsM1mmgorNtWxq8TR+OozgLfFZO5oqKPTOARZjZC+DDcwhqtxoi1dnBKvJCsNAqkDYVJjQW+IxSy+YCHAm268Z5deyiwWyli7zmYFZnR1g4HhRl81Ydads4cx781m2Fxi7fwadq4FFTQcDhiM2tQ8Phkf4NdgPFAn58r/Cuqd1XglauyOhLeylG65Ib1XfPbgDml4399mVisbvl8aHHTfUA1ek6ikoS3sluW3DC35LcBc8uR/3U/sdg2cd8EXkLZK8L+s47pJybgnvkUTLorNhWah7cDjhgiylzdAGauRg1H3+G6HJas7o5hz6T29ByuUODW8aeZGrQrL7sBNvyP/SJgc9S8ICu6pY3bHsjFQWafTkHFHaWbCTfTISrdibn8ShQSmPzb6hZxKmO3Vsp9Q0B9IDebbDOaaOvvsCym0egBut11VctsiD185IZ5OkeXuKo/oUffqp5GiUICk3/zqOorKWO3Vq6qbtHHo6pnMdHW32FZTKPRA17V17LMWNVN4aOr6jfRJ+QXdd10Et5WvxKpUchoyq8e9X09fRxGy1XnrSp51PpMhtoGeC6PfXSawKv+iuYZaz/wIor5EHbi6s/OcPtW/0RqFDKa8qtH9V9PH4fRclV/q0oe1T+TobYBnstjH50m8Oq/onnG6m+MJLn6v6e7t4jn5NSq/0h3b86X4xjnHf2WLN8wUnaCCJxs0ilQCFDiz6BIXUkNm33S5xWrJqCMksks2xD3JKkadjVgdSaDd5aagB5QW8c57DE1c9TKOUy8SCBZUikH0BJXFTyzJFalUPEWf/C+RGM9rZwmTB/eQMVAaSi70RYMa3ZvgNr4XimyoqE2xBlfappIcRGglCLM1/2ZTxSnGgqKWIX/TfqraWI1U44UYFUGWPUzGWe7/i2aIC1g1Xw1o7CqDb5J84JfKMdSQ8JxTH9LHUsszp7ZzJ8usUzsHqklpRqFjKb8CkswK+vjMFqGRONWCZZschpqG+W5NKMfgEo+9S2P+7RaQbLi2t7bEEegy9kx1T3VQnay30atj6mkahTKow+nuEYcqgj4doP1bONwoJydsiq3/W48p9MEUv1XN8+GeD1i8itGu4TdoheMds4EzThTTu8yUq/p3XQKFAKU+POakWpTARCiKxnD5iU5o2RSaPsduGehA9A/afpZdk1AVXc152yIPV6ybSEE7YXLtHMHtDkn19YB2N6AXCuXsKXJLOsMgOWEfJOZ0JnKPPMskMmUXGMZ2GAlV1cK1lfKkvgA+U3gvT3gBqWv5nSEhZQ9xXthIjnoMbc8BXeW23CJWWptigVgseRYs5sC1gcy6jmdtSCR/VvGKNNo+p25NdirJzOVu9KqT7+kzVfmdGVIFsn4C+Flxe3aD086NYDdoLGCKawtSpbAELU5uV/83bKGHSzVRrvDOMc5pxOf0Tv9qbzv4KwZ8HBZnqNl39U5rtOf3PoOziMBDyBlOn70vR30+R5O9nwXJ1WgJ1MynUv53k6AfA9HPr6LIwzQIws5Dg8E7ddPviH8JOcmvp8zAifeeA7aa55tp/n3uZv7e9m8/d1sQIZvN86y2fj72dx76v28J9+rCtudmmlvaNwuzBx7+U67V/Y73AX6XWwbhG4TXGcH2uk2dX0P++9AG+5W2k8G3T+We+/QiXbnnHRDzkm2z/lt0sq+Cwi08WfN9aiTLtR9R4utAXsG1lLKb7U3x7rHaRZ9TroA57ONIx+/Y31JvUZ2WpQI0aNnZDE2rWNYyjzTXaPHFHRPHMZNx2bNUvDtexwb4WXk0+MzJfBZcUbK7j+NZGsGCBvNfdyr2DNZa3nxOtFNvTNZp72fV6ChaIebLwR/i+DhGK89BmArRBxnMYsLP+ZPuEZWyO3OuUpssb2S7fboK74muIqIJwbxNECYSsq+uUFv9Bhk5ZmnGjFMRB/QIYbhAAvVQJbiAzqw/2WPSpEH8ipkguLojKfE2ofz+4eru+Ly6uF8e1P8enV+eXUX46y2w02xwx0iVcEGApob4k3kd7e3D6moG2rt1HzgH1/yb2MpdyMKIEbL8Ee/RZWLEv7ceSoHGxU4jdOh6mgD4beEoSArIv6yQkaxMYNyTNayWyuI3OINTwNpd2OKuLeHLvQRGElXTlhooNd1ml0NyPBwfeNsiOhWOnJ6aMhfi66REHJ+b7EBlbUwK17+68/yeTRRMPxBTJea6zxGCtfCN9wUy6T1Ya+W016K58TP2QNkqSym4p7Ca1odPJN8dptIKX/fs9mndszq4fq4B3XG7N75D5EMdw2NG0HvGQR8AB3FWEzS80/5Q8/ACQm1LIU1m9yjD8EgfmnoMXBQNak2pqoJb0V/6LlBaTtv8TeEu+h5ILDcDcAF7+ixC0xDWkU43on8MHOD/ZCv+IMfmoHAkXjpDlXxy9FDFWVg4FVwTn3bveBG6UNwOlDKlxEU5y9eteSfL9+zDCrlYYaB5P9Y5kJCkH/LH/MObkibkN0AdrcIqhxbzKXzaHFs8X5At0640R1u6tj9a1PBcVMDt+t9OFYd6R9p7heb7vC/jlh8ytCrB/+jCW/ZQ591+Ejv24j6V9O2Bda7YKaCS/b/zV6/VC5AfUpXML05lXC9fXqqSI3j+sy0B4H3miNZC0Fe/Dm7P228kBPaGYttc4Lq8zqoezLQ1Iuuh97O6EAMvfVji88PJOZ14dsaF+hACgkpv/eNrKBTOJPIJ9SgffDMil6LBbwtTed0AGsn0YEAX3W+oSWqEikiYq0ZCwteSDSIQsniQdJEQ2GLCenzO9xKhsmgUU/hiNKs4cEitWJ/BMbqpwa/4rq7weg1bHgnKCNirRmrC15IrIpCyWJV0kRDYY1V8fM73B2bOqtGPYUjVrOGB4vVQ//HaiCwxup9hzpSJqo5Etia0bokBu2oFKWSxausi47EER+ZXcIipOV/NaczMUhmXEMvrT9+YvhHtpFx2+F92MoZK4jwa89UTJirhJiLH5QYo4PLpsUWkAjjxvhuFQBjfk0oPB1rPmOQRAdDWPws57wvpOmOqGJzLu/p7wmjQgY+UWhqlADE55o22bz2f2MTVY+cLNsOSFWpCWxt58jEAIdkLDZ4R2h6/u/AAd+LK+BOWdaH8K26OnV6tFM4RGAGDYSVYkc1YAL/VmsBqeXKanXY1ulcKnwXMZAiHLLoQb4bv9iiZDFpexG+u1hRaAJbOzhkYkBA/HL1UNxdXRf3//jw/vZmVuEVNQQ9xioho8vGOBMXmLeq7aPS1KzAVusGKUtldDybzJ+2rBsXLbLwfwchmC4YMyjzjLuiwU9F+7Z/pMs1Z0tkZlCGfB9BYglXbabc1m2H6jJ8Ns6u0wj/HQSwpArs+pKMzpK18QiepcPKCrVtcr0cLvzLu/9QL6yOO3Cq6ibArR08KjUgWHaRJ4mhKrgOGG8FwQta87+maY9FjTQsttaZfb1QJqZzIuoigFv6JpmDcwM7JG31ThJtCrdr1qw+RnVAaxQnM9aGCP4sJ25zc6qN8DQ6GuN7XUeqapw2JxrVceXHFR3FcwI0ePLkpu+kEQ1pUFc0ijV5qzvGp46adjmwwaiLnjLlHTIBCuS5jNSb/g+uifP42NGzQ96X7oWiJ6MEBTzmBbOSD8Z3TsYltT5kPlI0P2nfoxaznZWx/DMSyPSPw8c8XNqozqVKL0NbupaJLK+UHJAis1l9Q9rHGdlNf02bJInHrMYTbUxLRDqF7sn+UCW0So+3Ugtq5vaKiYw2EBzTjiz2bTRjJ0j7ajpG3bHBUcdjBo0ZYqHgreU1IzfkclaTCQI2iegVsRrlZ+WA0G2Nh+9j+u0WixxbTGv8NHOYKzXb2ZIsNESwVeNiQQw6SKwreXBESCqYDaGJhdAL+RwW6INAe0vfcqaa/ZIsDJaQqwaDgR4QEpdX1+efbx6KL+c3n6/iejsmTSQKS6/H5pbgGNXo4/KVJl7jx/d2P/WBCxnZf0Jv7MK7ZIGr4K0atTpuQMgaTRAcJKoiVqNowmP4Po9B+tg4TBSW2GBnttNFhoi2blwsmCFRoS98eExISliMoYuH4MuNHGYYYmGAN0fCHdoRmiwSJLRVI2HJDIgEQ+GDI0FWwmIMTSTwr3OYoY+EZoC3zAR3qEs3EJLQVo2EJTNkxldf+OBIkJWwGEMTCfzrHGboI6Ed4G2D5qdxSkv7SNux62gdN+nSExQCFChGtNTeTtKQGxX52TrPmYJ6ALXQboXPPzXkVQoP/3V1jQ4aBuupFunziEvoQOo4L50bXxNLEpISGCgoDfShsSErYFEnT2jKhIDglATShaesh5bFGqKKQJogtSsFCFRK28h1skmTCQoYpBrq8BiZyY2K5ArPmQ4UnNPnKUNz1kHD4AhL4fNUQWlSxx2QdP9I08TjhAQLRw1xcEjM1CYtMsXizAYJxenrhJE4a7DEt8eh8HWiMDToAgnCQ4Vj9w/MWsxg0FDU0UcEhaCARZ1sMSkQwsJyFkgamYIeWhZXfIoCyULUohQoUDloskid0cChqlMgJlgEFWwa5YtWgREYrrNEysAQ9NCx2EPjMnr/06DJpdfGKw1tqCtmYoMKeSJgJgM4f/o4XZ6a+Rfo1vwkfJwmBPWKuAOPlGnS0QQUNlkX7P+J1u1/TVnjaQ3lVgJv/Chh4E28C3R74M0fJwo8rSLOwLsmVZqMNwGtG3gzrTvwNGWNpzWUWw686aN0gTfzLtCtgSd8nCbw9Io4A29bJpp8noDWDbyZFtDiLcsaT2sot0w8fZQu8AQNVHRr4Akfpwk8vSLuwKtJmqZ2AlplXUxLCjkCNUkks/ukgoJtdf/S6t5bjpb8eg+cvZMdzi61SuPxCWnlXDPzApLN/HXCSj9rsMS3V3vh60TxZ9DFFYGaMEjgEFNMKPem3YzHAGJjcAJaNwRnWkAETh+ncvnMrmDbHK4xeXzpDeb/ebEx67nBbZqsI4Gt63WZGuB5SSBd+pH10LJYq74ikCYo7Uo5gtMQIWkcZYmYnzX7xpJE6Yy0bogKvID4nL9OF5yCBkt8a1iKX6eJSZMujmjUhUECh5hiYhGEHamfE0XhBLV2GM7EoDicPk8ZiLMOGgZHKAqfp4pFkzrOaNTEQwrHGKPjZ/U0PdttlyQgBah1A1IkBgSk8Hm6gBR10DBYA1L6PE1AmtVxBKQ2HlI4xhgdakB+I135kiYgZ6iVA1IghgTk/HnCgBR00DDYA1L8PFFAGtVxBaQuHlI4xhgdSkA+4N/TTKJNQOsG40wLCMXp43SBOPMv0K1BKHycJgT1ijjCT+P9eEcYIkENPLJPM48yAa0ceBMtJPDGjxMG3sS/QLcH3vxxosDTKuIKvKX34x1hiAQ18BqcKPBGoJUDb6KFBN74ccLAm/gX6PbAmz9OFHhaRVyBt/R+vCMMkaAG3tuBPjfo8PKWJvxkuJWDUCGHhKIskjAgFV0MTPbgVEUShahTNVe4mmImleOsUaQE8D9w+zHNHOOMtG7YCryAiJ2/ThesggZLfGuIil+niU6TLo6Y1IVBAoeYYuJn9TDkC6VfTWchjy2+xI/0GHOJNccvBKRVtgXoWQH7AvIVmR1Q3c3Q5qPKguDuAlXVIyq/ptNlgoRtwZ2kaN01tLoeIzOmwlh0MvLZqtAkpJwtzqMZJ7Gpkzx2ZZdBHno+5PTRgG4zwZohLNarXTmT2U6A93c+Go+A098jr5wc8IsJCXb+e8nr3RIsmQ06JN7wvuSFnPweP45ug5f0Crjj7AtmjImcLoLBDr5o2YNdIPGblckUABIh5MiL8H2yMJCUWFK4DkLVO8LKnioeZDzgWSiDDuF+UbSwapUrNhRO0IkoSSRdhCiqaIkccXJsO7pPFSQCGCxCtOzhrhH5zcrkCgyREBIVwvfpQkJUYknhOqn0migSJqSVBvNLXshZpUVpE/AaSq4eVnpN7PeZVgG3e/zq9wOq23TNhIK3svdVdncMGMufTAerReSoUD5NFhuqCloix1GyBj3vcd0lChMZbuUoUcgBZ8sMhU+lgc0aylkz6ctkAaIooKOxh8cvDT0eEsWGgLVyYIjM7qjQljkJt9ECcjAInyWLBJF6QWCPgV9xQxOFwAy1cgQIxO4A0BU4BbOp9LL356+SOV8gVuHtrr89duyy/0Tel9BWDgCZG9CJlwSSeUJWQ0Nim7c0eCORTSzeUQ/KoEOy6SgBa+WIEJkhh2Tmz5NFg6jCgsB6EEXngSSWMPpD3dzaNbgrXxJFgYS2chzI3JBNrqJAsliQ1dCQWLeW6r2RyCYW76jbXtBjmygkZqiV40Eghux0mb5OFgmCAiq8dfuIxvYpjGByxGKt/jbiPapb4LtfsauXt/BXtlIUhz3Kbad4eDvg8C02Ik83IJmX7mn3wi/Y1hn2lv0bvzqQvZIYrBCnKGSwVRxrJIZ4OnPZN/xfSva3ticw+4iL8+PpqXSZwNb2g0wM9UPGsvd+IOxvBj+Inmijnq/l0rB1dX7fdlSJZ7LNI0fTFS8vezEDCT+uagCLChazJNwa49QC8qTmNoc5tp4uSW4JVQHIHThrGGJDLJEh5wN+4fh7+nuqmloOF5jD62o6DQoRSvoFtrq7liJWIyWvuQ5dQLU3l2m23k7KYJOlEpB6vJ5JNsQaL2p9Zre1p6vNDM2nLqdhL2Yg4UdgLc6ugsUsGWqvUQtgzU1vjq2nS5JbQlUAVl/zG4LVVGNkKPU0emAmVlPTIMzyVEIKS4w4hd+oODe/2R7pq6dJBVjlTG6I7brzEw56UL3MbYMNsc1R6J6NSFgtOZ5XzUykQSFCSb9Aq+g6iliNlKO62nSBVtosptl6OymDTZZKAOvwSibhldkcL3J9Zrfep6rLO+RTj9MwFyPM9APs/FhOcqMhktdVEz+kjqY2wdbLAYnLv4UZYLXib4gxBpT6R8ouWf0jZedR/5IwFyPM9MOa7tdyA7yftexGPyj1L7EO21M6YOvrgczF3xCLE9QHNVLVvydSebR/aZiLEWb6YUX367kB3s9adqMf5PqXWoftKR2w9fVA5uJviMUJWRa93Is6WSamIbPPGWbY3FNp6acPnDMFWUY7kCFN8m6dqw+XvB1zNVrJK66rlgqE8fsyREbzJgyBkl3bn4yR7W12EY5XsCcjPQyALmJ+53Yy1oahuSnZtcoJORmci7S/OjcZacvhnKT8etR0pBzORZq0tpgqi75TkaqqFhNOsV13E5mDHvSAUm4b2HLY4iGjtIqc1hfershsAHP1UDuZ7LLahHXyd2cjzS4pTUdI9s4GjF1OmY6wwW7C6UrBdLQTpIuc3yKXjPcNt7Wr1UzZIzF1SAxJPQ11McIUE+CKWcRADkkieYtv6R6q74GlVOKULvD1QNayGyuDksJTd9Bt/XNDPUynQiFCFRLwigHhUAJSN9cziWNElSdUZKW+BzeFeGk1e1grlVKfk457jcNeQ01ORF5MOMUMuWJkGOkhVTe7DWyzERkiQVDktL7wdkVuA5irx6JOppwYMs8LGWtlGvpiBioE0FWDwagArGrmN4R13i5HUIjKnNop/j5ZwQqWCqPU07RzqeapVEM9TUVfzECFALpiSFgUgNTTNQxhnerOERSiMqd2ir9PVrCCpcKo9TTp8oN59cFUTxPRFzNQIYCuGRJmBUD1dAVDWFeHcgSFqMypneLvkxWsYKkwSj1NuTpgWhww1NE01MUIU0yAKwaCgRxSM/MW37JUk979sxKndIGvB7KW3VgZ1PqXcLHMtFZmqn9JqIsRppgA13S+nhxU/7IW37Jymd79sxKndIGvB7KW3VgZ1PqXcO3YtHRsqn9JqIsRppgA13S+nhxU/7IW37KQn979sxKndIGvB7KW3VgZ1PqXfCuFfSeFqS4mVKOQwQoFfM3QcCsCqqkrG8e5GyZXAKnKfS+OC/PbypZxVDyl3ifdxWTcxGSo7YnIiwmnmCFXjBIjPaRSZ7eBbW9ZhkgQFDmtL7xdkdsA5uqh1MkMV8+BPJCL9zT3H4JrYLZi22/3y3G333dzmV5vgJPdnwf2fdbiu+6DS38b3HdwCdvo+RPcvObh9UzFtt8rlvxWsVPf5zX4ev1bvOCezlNk61VVOS6q+m5uhppcfprLoHwcn6/4rsuNUl9tdNJ7hQaTr32dENjTWYpruzon2xUuKw6TTnxZzUALOGmehdh2MUu2C0JW9O6Jr0LpaSHH+rMQ2679ELjLJGO+ESbMu94v5CikgCeCMhSTtX/O602WxP5vEincW4OxpYeIEhc40sEJuSFtYc6ym73+m93vkTqc1AHeHshb/A2xOCHruf9TnPaHGz1LaYH3xGTiBl3vkPhY7AlOAp/qCLbr4HVeG9tOHGc/NHmic6OnPtALOcK7ju1dZ1QzHss7xWnE0x0HdZ4BzW1p67HHrCe7TnKo7ZSnC90nCvPb2358LusJoZMcjjrlKTX3ybT89rYfw8p60uQkh2xOedrJfcIpv73tx3mynWg4wSGOU52ecZ2ZyWtj22GRbPvlT3BE4FRnM1wnMvLa2HYUIdtu7BNsQD/Vzn/Xfv+8NrZtdF9lL+7JtiV/D/vHYfvF1/ODexN0xn2fp9juerr9xs5Nxrkt7dhXK71vX+N+k2aIAj0ZrfHjCAHY476nO1z9tJ2IPzX0EPyuew9RcMxCwVwj6Jz8kAA0mcJ7edCqjd06f/05XVgIqkw/regMmRPggDyFNdeLZRW8oPUTeY6qguUIYSnlZW8KlieCatxENti0HYAslGyxLoqKlP6JhZFGpRUGIFSjCW+NKLZyr5pOjJr4ppLQIJiUGP5/NfOLfLAEkrSIprhfJg5Wla9R2dHmLaqWsZr8NOFYyvnwdsC7KKpuQDCSHDATpvUNaZX5DJ/NQT8ucCx7gm67F9xE7YweisdwILu/OWHUQrlACFmUvz12Fe6+EPwtgoxjvPYYgIQ8y//U03+gO1SF1ZJJ/eVfOWr+1ADSAJSfZ5m4DO3UaEFl2yamdZHfdjynQkaH/SwPQF8o/dr+dGxxwrjhmIWMuWbUGPkBMbOSJTbHFveVfD/wmOcIeL/gB8Mx5qAWQlRx6HXs1nSQxAmpyEIpOVMo36KY//af/+cvf30nb1/jLUZEp3bBOwOewMgKOShtagwQnDCXapjtofRnh6SayhD8L6fwwEwMb7QycBM6Ilu20CZMfpIKqzcCBnbPbkMuLYgt+c+qcIn0+UjVhqvBO7iHgQYWIZmUOlmq1KkQ18/MoI8YOmB3pVfrtE4K8U9OG4xeATuEgaVXaEI9mWNkDeDO0dgjusuhKOSwEe98/JZsIC8qNP+4pl8UVsjsWq4SWyY01Heu0AE3cZMnBwYBnzuJYiwm6fmn7D42cYI2uI8S4cnHSE8my+vTYCIvmxUwel6kPv90dfdle/X34u729iETf9FQ5zEpkyKvqCHoERjwMogceWfvRDZSP0dWK1I/e9SqCL5iFJ5+yF+ltIyQx8XSl9NoaTWAaNOhKtKpHMPDrVGcxSwu/JjfuUZWiINzldhie9Dbj15LNOYzWNLqjOYkiheN4ayPwrE8AOFJoj9oIrNcXdzeXRYfr75c3RVfzm8+X4VXkgaXtNkVNX7FTfGKqiO2ne/gH8fVyp4waPmHrXQFBeqst/hXBhdWP73WMyzkgGsG2HdRYwcL/QxuW9HJZXV+FNdxADgxb4TLE/NDT1+H92RBWvCT2K4ObVZH6KNAbiPY0fwO1d1PaRKfrFcPXSyhQXGyvkaQjA1eYbtEHYpVeJiRYFBrVi2VFnilFUqQR0VqXbml9Pll8JDvEp+Bj8MBFvpm8SQpZFBBQT2Bv3UagE7GmuwRGwWqQg4bLWbi4vpUokLzj2v6RWGFvLeZq8SWvuXC6BVF0R1ZhgHvyMZxFrO48OMKjjaxghydqcQW2y8c/YpDdyL92AvbBmL8g9gwYhg+YRTDWcziwo8rhJGJFRRGmUpssb0aRpREepkSuIuHLegXtAnbATVoO7ZQDCe/hw2csDtlExeUXanW2HYH80+3rOWvxezg2RfQsEvA9h1AETE1UQ//v5p3RT5IzU1cRFM1Umvr7e1DcXVz9eHqY9AiyMhFuwJXeI9rexm/ycMKaA//x0FS35kXLl0o0dMTrSK2y7czAjT7mAaMozK3B9aKBjl2hBjrjQyZPZQB9KCbOFYxxIaMvqMjj2X3xQgQPuIzqbTOaM/N7uOZnFaY/WLaFPNboho8KzP+sJ4bJEbIw8/py2nMXQYTv4vPku8Spsl352V0eninhuEAulocWBXwqZHZrTFXy3eohOfLd7809HhIrBbHPKGPZn4vF+U1heCg54EIqNKys55ZNTITQkIoQT9gqd3KXSKrAl5RlNsagrMMHSOzVpkiyaadZyzF91yW6q3bg7PxewXS6KyoSXuXVgY666K4yVm5NIMcKZo+fkCPid33gB5PGDwju1fo5DOCUL87TgJSJlPe0SsFyjif0BubRk+i0IC1epCIvJAdb2qRweuxJmJ9wacl2WSDFEGB6acVrS1zegwG0xbWPEoz2PosfkB4lnBAeJZgCHSm5oCzlQeEVgV8cnR2a8xJ8cxnQHgWPwpaqrXugNDG7+WivKYQHAQeEJ6lGxD6qObXiT9LMARaarfygNCqgFcU5baG4Cz4gPAs4YDQTzvPWIofEC7VW3dAaOP3CqSkA0KTVgY60IBQdVYuzXwGhGexY6GlOmsOCM3sXqGTzwhC/QYOCM9SDQihSq02IDw70YBQx7vKgFAlDhgQBg1SBAWmn1a0tszpMSBMW1jzKG1p6wrHbeJqGQR8G1cUYzFJzz+t4V0tJ8y7GQprNrnq3Yu725ubgp8Wfji/++XqLvDQ8RLIcvD4vmxoVZ3v/nlsI25fbDkKGlFAkRXHW4gA0i8rhJiNGRRoWctu9cYipbBPH+ghNq0wmI4efFJLJHMhIci/rRQDZm5wFOQ0gN0t2khIEQa+MRBZfqHwK7pexwpxuiXJp9Gh90HBr7noUPOMG2cMZnCAJRTUuMOoKV+Cb3Mb2DiI9ro2Q+TFsRaCvPhz/uCz8IJGkrNMxIyMTQki+MJ1LDenF2wxIQXgscUp9ZDhVg0IDTXsSt3M5We36dq8YdIl+Ip1T4U67UXsujQVcS3GDGA5jdV/FNkIcwzPozqmRb+LBqMu+n2auVjTSRMVd6WK4tYBdNrHbBXPuVKAUk5bLaZMOei2Phwj7lRcaqbCnsBjWhXgzZ7OJLH+WqjkspPBW6EXVBg1WuOaECe5h2+yGWDskRhu6dBqkqHeGO6pWdcpQbUm9voet0IOG+mrTNzFECal1rsYAqYB3E8ae8AXApy6OMyjXxuI6s2ISs0/rukWhRUyvM9VYkuvbmH0sol936blGB7zOFGcxSwu/LiCo02sIEdnKrHF9gtHV7js+p1id/hfRyxOJntl6B81ULaNAvcvOOwFhKGEgzgksEKZCi7Z/zd/JClckPhJVjC9OdVYIX/gTw19JTs+HRjqOPIHPswoEP9F8hYigPRLfqdamSEuzlt2qzeUKRXyB86hAZtF6aGtsVcxiZiZkwnANnPy4fzmprjf/s9VcXf1t89X9xHXJrR7VFUFK1rRTInV6OYalV8T1C0G41m5YpkLCUH+LX/9cnBDalh2A9jdotQy9mkeLVhFG9CtNe1A6joqCCcASPiFsxWD7Pj/+YNNwwcJsMRFNBlY9eO/jqgJytgDyygP8WIwV9GLDv+X34ULNogDU5bOYFfVecfHf+Kye0/qHakjXrJue5zHCQfizGjuQoZQfs3vZCc7xOlrWMHhHzUovpGufIkIhlEeEgTBXEUvOvxffmcv2ECTXfzz8OniJSnpreu6y7sXiZhxNDI7l8lTetQQS9qAjem0TwCWTvsDemzjZqo69NgGXcTPqGMfEhzVV/+25pOKUB0gVYvJxb/GDNFIobJNNsW/xgxRyPs95qkAcV6bXiCe8NaLGAM3bMtI3vKzEQ+r2pGvLydSclgSOYGLtMxeVTkHP4G5xphPUmiyzhodgD4msSbWZPYL4J3LOQMm02elJ5wd1FCH5Ct87wjDc85Cy6Z5OBi8YmtRwfh+t+6RhVkubWyu+QothN8vKvLaQowPYE2973DYDQY6fRjYSZwyEUO9kafYvf3bHtth+LhdJjo11tth4maH+kFjhcBBgVYVq10Wz43EjBpnRcYf1vOCxAiwfIZyGsfLqonx72l2FiyAbEM99nHElMMobptw+KUhu3vadP4t7o+TrL5VFUhIFTF53/XSnrMZpMIXL7j8+kh/DwsXUi1+HwHz1xAXOaSyZLcA90w5U4SOSQOjo1dwTJ+kyr/ioiUEtRhJi7ghuiqhtNSkwhGttEK7UutsZIXaOEeJe2u7e6VM6gPdRft5xFnT3BInMLckLytPJ/se1doUR1Wm9RKFT4ZIVCZtW6kxX0y7AEj9aQLFERQiyR7H9JIGcVsvqUF1W6EuphwCBKArE8VYTNLzT/lj3sAJyt2jxAWtn0jYCrWRn0ymL0d0YyRlsbrZ92rVbHBUIA/i1kDGOHJ9scEe1+UMr559DG4rBn3HpvnjKg2jiRQSyumLuiG1vlFM49aZePxhPQNLjJBmMn05jQGt1s23A31u0OHlLaaGSiCWenpscT9JEHkNxLHF/R25gHPmAmHwOXMda6c9TC5TH8ivqN5VMVs1GemBvEwwdrpP6JnUqKPRhAcByEbZNOgtESmDAtJeoPIF79LwlhwLSkyr474Ob85nVg7kbLk5Zd12DSJ1xEkcTijA2OiOTUubRKblWEDTXmPUHZvIZvzY4qceR5v7ZEJS4chdSYyOobjJ2Jxi+A3iE9tzQ3aG28EXdMGzBhKba8/aQNafLEtRvFZAspD+StqONm/3HerwEK2x7C89ZMsgDyKkRY0b1HaJ6CvUdmBa0nYJwqkibQcJJ0bX59w7+i0uphhln3KbHspF+0Iio5gzDigOssuGHq5J1eEmnnLX0MPThOUg7knlx1m9umALHHsvjH3L7/Rt+7p2Qesal3EtDCs0ETDLCdNReFER9juOD2pRj2qE9FDjvqMNeo6YF9Ho0U6YDkV4X1VevAqk5x3VtkdykOqSWEgEzjjuCIy4w1kq5mHCcRUyuknkdO4mkZHd4SSFazCsbP1FAnHO6zHcjkvT2rPSAVt7iZS3+emY2043hbWkpw2rmThwd/KPKgzAykyxRK08LyS0qX+gz88VTjF0ZdQdRwONYBn550OLm+4DqtFzAvIjR9tPaDZyWqIqSaEZEKi88dMggAmQ26enFndpRnSUYwFHdLc1G7zy36M4azZ4HWDsdMMYMi7F03ocQzqS/G2NP+D6GEu27zHsRCmaSlpjUEvJ6KIbSkbmbidva3yHdoTGUjUDiJ0qvuGgNQY0F5HnjWY2jgOo4p8a/IrrFCPCQ48EaSkG0huMXuOMOnBWA5Cb8iN6Jc+xrhxY6xnLQvy3I27eEo3z/8WwoAP9JLcmr30tq44VMF0een3JTKe7pCTN3Q0zh/Z+BpmkQx0pU/QkWo4E6kpEHQQCnMWSyL6QljySinRv0fOnrxOUexL17+QP1OziS/mN47jK+WV79/D5fLjD/eLX7c1lOOkrabojGm5r5+uOUOK729uIG24k3oZSWxfqS/9tnEcHQvhSeiRrIciLP4MWe7lTi6ubqw9XH4OMbGXfcMoCV6yHZzN8zJqzVQHAur4gE77L0KoEEULC1SNkwZ7PHyz+Ae7IGZG2+qGszKfKsfYEq68Y0+nneCUKGWI+CCz/PfvmDA81YAej1zUNoKkE70yf4cMfzFVUHzb3KMhrO9WiBSwXrmkXlhjHv+rfE/5Nr1xsrrYruN6pNT9N/BwYfY4NrhzAdouTbelzx2mzaVgSXcUKjvZPcczfEYm8UvkbIh28oY3hK0bh6YfsbtczAlydoZxGS6su5YM9NhGNSNSlif2osRSAjKXlXw6zVFHTRT1nLSLZSSODl2OE3LNk6GskMH4xF2z51wk5f+iDtYBUh1XN4ozcZXWJi12rbjP0SX2mqAF22nqWcVf+pd9ibzqzqbfmbWc+ekB6hsLMYVS3EKrXgnDZI0x58xlULfvtZ9r7zyLnXEXVpvGtgLlmJBn5YQP+NSzhmp0Gj/ETKjuMfU7kNAO7Z6XPpQWBOsuSgVJptM6oHahCXFLOoI/oKcBdTGLuTKrXSnenAejhLsprhtE1ee9RcyjidZeaKJk+cte8UQ2qg2+s5LeKHDXgGh180ZhJr1XuWHOSw/2TzwCjR9z3rc1Q6eNkvflrmAZwz0TPWbsVcthoMU8dN6ckKjT/uKZfFFbwID9DiS1za4rR/4HbjzTiNPYkb9lh3u8UfE+PdRl2rF8EAHk0PeOm36T4OEKaXHoed2jASOzaCBoTw0tOU+j+tvQqf0A6hpYD+Hg1IePo1REyo3UFUtAEQPQuWw2xc8vt0r/sRGQEOxP38G0qtsGvZQ/nKuM1eowgvUaPHiVMwzWU74mD5QvaiQ6eD/ozoTGcHMDHogkZR7uOkBlNK5ACOm0ZikqsZV16NnybiiDv4dd0fINX9fteUjrVbweQIBM+MlkQE6Gw7oFqL74to5oYJu7h2FRsg1tJmbnpngnhaTD0qFYxi3tYNBXbYFHHGbF4i86E4GrCRGJryUxL5oJC60j4zL4g7+PTZHwb2O1VCdzqtWAiyEQ7VlgjEQrr2gC+/YQatE9FfBjBTHQ353e/XEU/JrxkrlDzjMEPCyd50XiphNfrxvE3sy0VWPuWNpcG+iNoy7xy39FDZIs4Qnhkl9Ss0ywFPWRvj2VieJvcXzQQQdwDeFg5JeNg4W6EzGdfkdTDug15DrxDoZAQfOyblHO08ASa0cQiLbitTFxcYi+v5OIKN+FbaidpmGsTcm0Q+9Vx1jPKnTIdqLq0b3UZRsYkYTZMwLFBA0gWu800kPBnX0d0EmcywgsF6PMfu5fwGByEYa5KxrRBx+4lZ6xLZKBQP3aUnbMPTFmjNNSOybiYJWk7gGUypUgHqQKjREQ1kEnJVEjnOOmC2TtmsKQwc/8Zxkti/LxvMNqVzXH/GMYryINiKDXf5lECzBFJC0pIvRSE3sWyvvO1bCJG0bbvLMYVBdlgLwN718Nmdu87cK4QhSLWD5fcRCy189YeSY/bQy496EGrhxjvF6jC9Q41we2sCACK9/SMm3L4S8YWfkkKiLZRaNvhfSJWMpaV9JhO7sV7gmno3TNZkwbBjw9Z6J0vlF3E7B668NkilY5pU5o2JqWKYb89WNtRICJTypxkLKE7Q46CrO7I9zHHs7O6s+sxnfy3B9yEHzMzKEAFUEsM4zp0TbsXhcVvEpZNOcJkiVyBCNKLu3hB4fMko7DHbFtUkhXphok2d3Y9P+4ITU7OQL00+IB3BN3hkja70BhaarBnoM0MatKAibITtg2tAi94U9jLF9SVIqCNOU18cU5Hzr84th3dp3Z2yVGh3o6qvRKvu91hD4KkLi17HgRa1g/HqiP9Ldep1dgz6P7Ga6g2eRTx08HyPHWwBgzazi9n9MDtj+BtlvEMG+2mylR1iDi2T0nWohVtInYDC/Iw2yXm25TsD1n3Hi8oIXYt6X7PNdIZ4ZK9gEPKr7j5af4xSLeepphRhB9B/sjNv9mxp3lGghzuAagA8NfV7wdUt6Gd90GHCSTsxIzXBQILygHOcoQkQxk3WMA0jpAmmajDUgsFFNzl0ahcRY91dDpqQB8pa9Hj/J9QDzIpYlqXFGt7+LboQY+IyxJfUUPQYwidtoafvTOXKySh9FSa8kmpZKvbcR1UnXsmAc9WjdP4LcZ78ZSAKpu8mBvXtn2tPxPwEusWeumIcYf34TsZB/4JZL0GeKZ0N8Db6eMUNWdmVnBtNSiDmTdsktS1YTQtb6yj01FDJsdNXk+oBZl84NyHkNMRllCQazt/2i162DGjrFffBU5AhZ+/TlHjBW4V2Vbnsxh7w9/Vcw3sUlNHuzwlOaTuGwMgqSJkdoar/uf2iC0u5BzA7ochddiC76DGALFe7R8JAVV/+DRFvR9ZJUxbjU9s2g2d8ExhlY4xzqlpaCE1W+/fRPxksLirNmcyu9Hhcg3+hA5xaYQDrFd7ezpA3eUfpqi5PaOAZ6u1Cc25OQxYpsBJwxXjwHhKSC3VeTIBM+H2ddXO5EY2uFWulQ9kP64uzD/GaDGjCD+u5XQzOcD9ucu/6cjetLrxm7LOVrddg0gdsRtAggCutuVg3ZTT33LuQdMQgy79mQWT8R5bXIqotvXUw1sg7eEN6NNYhk3ZQ+Tx2kgCW30+vEUtBo/iYMulY+NWzLzwLBPCLHqsux39FlrEQRpoz3Rcm1IAy2NMiQ6yp3WUCO8+KKRkKqT78NwlLY/s2bvgxC0CZG+sF2QAA6cv4WY3/MX52tolDS1n/ougRw6QCWMpNO+LSnZq0PNlQw/hPhIAYNtkLy6uPj0Ul1fX559vwu7VWHBuUFniQ1e4DRrltwUtwIHJ7bvZNeh519CDuw409HDeYBTBPQPkrxUqGci6qUu4YZZFDUaOju92lAxvO5bcZCR3tx5XTUMbdhnpDjVhvUUJIbt3l2yQnS0ZCrnB7E+PM6jDxsGhNUmvY1ufapOyYL09nbnoGu1wMOMonN2SEhFke3qyUm2e0A67rYhRd2wiKGf5/LZUuCDm7EWCDyAvKJ/6P3T2o8eprTrSupqQQS4NJ3ma0FyE4buPjKyu7UfHFie38rHFNkPL9aYrw+8PmaRXqDMiE6jGpCvY5on96g7aQeY9aiPWxhRqMnE/ota5KDYrcfv4T1xGPG1iVINyYLgiGVSAkz8cD1UOX3QM16nGHX7FMVufVPqG47loe9YUhM2IZMkfpMJteDUbpfPnD4kJeL4uVcH4wbrWmT9GmYiAkWnJxOuKGdYKpSwwa4EAZZ7fKRieEw1s8hfkwzMF9YxqDuFfGhJ2gycTzB64Ewlo83RsSTbPPYRlszTZRdx0MBMRxuS+4YAJXNDquE/CV45IVr7w+qfQOTM1/RZ8a8NM1dBvjnsaHtjH97SJjcCOFartcWyrkMempc0n9Exq1NGw9eeZlC1AcsCDAGhhTxahxxaDYnTgTBE1AyUgW3OP8uPJyQraCnAW5tunpxZ3Cb1LOaDZu2quDm6jRuFVcrZPXyNdqXj+dg76fu32VTDfKJzdihIRwIrpSrVh/3FacfsUxLR9ym65gQKy0htVhg15sh7+eArPiRMDeQI8l7lHz+HTJ5N0fr9ITBD3JCzYhrBf3VFdP5GadBGsAkB+i6pkEKMmL+GGDH9xWve/Uf2I6mDmWTy7ZRUq0L2RFDVh4w+VjDwOUHauiIGBntE9PhB4t2xXdB0402LjJzOwXY9L8kpCr5TSK7CbEO3MwZc16mld9zRyzjuapNIMlA21TUykraebr/x3Z3Zg54mC+JggbIsJ7+Cf73byk60hVMMtbGi3ayvNVpo/KZzX6DEZ5xN6BHEyuWSk7HAXiJU9E5WMlT0x5WB9T3dvEZlwZnykuzdnBmRsd/RbggIyuoZ+c5Tu4gWXXx/p7xe4qhKQlgNciavKyUwOiSKI3XkFiJ+LCrUtKVMS94h+/P0rj2k16J+JhOjADx4wbyeJ6f4cA/O2M7Jn5hTFnngd5Y3po810gA1huOZz/Ok8u2OIYL9y/nuMmvIlFXfL0Vy8BFX0OW3BOSS45Em5way/YhTTP54ZX9hV6a66w9jStAqMzt0qbFN2ZAi0J7NN2ZUh0L7MNmlnhoB7M9uk3RkC7s9s03UxCKyPsU3cySAevYxtwtaeANv5bdKmjoDbum3SVEjAuXCbLj0RYH6abkRPVdjpNnRIeZO1swTUxsaPW/nVGQ6GKeUnoJoyPojzGj0m43ziWG7O4DeZdaSOF5mZyGXfg2QxEzZjL/MOHdJ2gLMx3zGGBJTNgGPjYsW7RmVHA3fNy4ysdE8Tmo03/JlYmbHTvgo7c/H7qJJmWX6lFTjTfqA73NQJm7Q9BwS2a6mTrk/OTZZyQRmXPUJ8IHGL8DMle3n4QID7K86bBr2lZGZ4QO4LVL7gXULykgNC2fko6ILWT+Q5ATVHK0c0C++vpGUp5r5jlzv3qoZu+pA0eOlxW4Z7EHEtutygtkupQ4XaDsw9NY4JeKe20c3ZR90d/RbbSg28fdA1PZ6L+4UErqAvaQcoByM7fNe3IIl42dG9pwnQwd4zB++KW5D3xI79cQM3X9Br+z1QF7SucRmbywcliABcTsAe2rDfcaKoF5WpRlwPXe472qDnsI26VmXaCdihDe/kBG9nXOjAezjuXY38sr+UmY/4Zb5P6K2iKLYTORGPYC7W4B08S073rkY+HMDpitlgWCn7zlsaznbEcnLG7N7U0IJ2b0rMvEeRmL7tdPvtlzrQhtVjHLZ7YklPG1aPsW3PxMjMFEzZjeAlhvYlHujzc4V/RfUu9DWuBX/HIV8mSIcGnw8tbroPqEbPqTQ4csj9BGnR4G9H3LylTKP/YoCWPCrtr6Boh8OPd8/i2XdfKVSA9b20ZdtU/HfnjpUPKOy47AeU/xGCkQNgvNhibPZoecZXtlPLurW4QyQs44kAK1hOIYPs/hOFIl5rXnKTPf/Tjv/J8FqzYOnz+4eru+Ly6uF8e1P8enV+eXWXSJFej6JXpGALAdZsJ2tyd3sbdqWPS4+G2mfkkkfeRvQHkJk19RnY9z2spd7hrqHBSXGSzl/jJCZQdWMS4fcVKIRkz353PpXCpe7oMbDXqCVtBjhjGCV04YYzuls1NiKM6SGJAPljRyUDhU/wOxhLOuJ6AUUU+cTsH7ppecnNqYee52GGtmpyh2tJAU7sTS9AKS7+t//8P3/56zu535s+pFjnVyy9pdQvlH5tf0qtRcFhCwV21XC3qAC7MHctgzidZUo/yapLoUNd11lGDSA99HVtAssrotPG2QedBRNl24JzFNt1Xn+yM6/Xxmi4DQ3Oog6piT5OA3PCX8X4Kj200uQ1Ql9RmpFDdchvS6fE1951s1dQpkpcyM34vpmrfzO2Pal4x2bLWtc+0vs2rKRcMrsbZxaA+1IUZlPTtrU3F7dPT+yVmeBxjSCf3X4qF8CKqYu3of0fnEO328AXgW6Bry71l9IHb/MZaTb97fmQs0/v6e/xdOOGZCchpS1OQcdw3Cd9HmkCLgbjpjpUuEtRsgHJQVg2GHX4muAqbCVz5uNATwOQne4GvdFjbPk4UjUiGU/VoBTG3CGnIaPyFvxJs0tShm8YnHlICTgMlMBw/G411ymKRJmKgFLVNl2uIsBktU2VrQgoXW0T5SsCSVjbdBmLAFPWNk2dJoBKvU1T3Qigvm3TVDgCqXHsUoQ2ARe7DaF1kd2QOkW5WKfKRfWJrQzgNkXRDgOUi/IO7UiKutYwHDdZR+rnJGwMyEFHWnY/cPDTlTNb+zjjuMmuaXNHo0s4cT7RxrHwOFPfE5aAUjG3I5r59FPFBrAJ/NlyIOdhq2+ki9j5L9BxIBddoiQDyTEP+PcUaZrBOanIPkU6Y48SOqkanISqwW6qtwN9btDh5S0F4QTmov0Hbj+myJ5vuK1d2TNNOwRohvboa4oBFYNxDafYNykGUwzHOZSKnbHYUPvr1DWOOLEikjiPqtzWOPoUoUgIPEN42wdgzLE+kRV2qO+2xuFn+kQ614m+2+4FN4mGHpRhQYYfnDRRS8NJIc1Num4msJeZqJMJ6WOm6mKCepip+j+g7k+q3g+o85OmQwLoj6TpjgB6I2k6I4C+SMquCLgn0h9TjdntPnH2Z1Rhu9xpiapUpBUDA9H2LS3/PZa0b20HKDvl8PhPZGvbcz7NWHbS4MsJFELHvQQ9WczBJ4UPdOyJUQafelIJ3WeebmvMG6IUdM0AZKcLP/aj0AHO+gzPe9xg9BpPObzqUQ1gFlpWRFKmygEtR3MngUTjLvOwS1npjHjRe5LOv3osMUHWjhMWjPWwDQ+VK7bcluGETHYNO048MCsmKRKzICld9jt2FQ5/zXoWz29FmQqyja0XScJG6IjlYAvfxGOgdG3RFnkjWj8LufO1tF44ObmLlxeZD3jTUfMC84Gviz1tzdn0RXa/upU6ylh/wBJnYq74hA4R5xQn6eyZQmaCJIpJIjyQFFJyYL9DHnBLadXNxGojPP90dfdle/X38JNtJlb9kTYphkj9HF7YQTh/BIlEgABKV6rNgdTPzr1yn2jTofAnc2bx/JaUqSC2TFq2zYH/7rToHS5pE/6U0yye3aIKFcCid1cXt3eXxcerL1d3xZfzm89XSYgb/ntR41fcFK+oOtpGdmntO3ADvMomDSJYR/EVvCpRQbyatGyb/sIVgEXZw7IRrKP4ChaVqEAWTVm24Q1et0UpCafsZfPbUuCB9KcuaOBzQhIRKan1KaFUlts0lDjddF+ipycauIY9Cmd3lEQE8dQoEHHvg8xJ2uFX530PE3d4p9tA7epyp/Plpp2h3LHzLorw3WrR8847fN5FXMuksE5efOd+Y3gSDb9OwcjuvFJBJo96U8yuBORVsQkhQUVeaAGvygN9HmP0anhZ4yHw/m+jDp31EnCJOI8ROvQIsEDKjDPluHegJHcWRXm2WpI7805yZwmS3JnizzN4kjuLT3ILdnCSO0uX5PRK+FTrswRJbqEFPMmdJUxyBjW8rBGb5BY6AJPcWaokp1PAI8mlyDhTkjtzJbkKBw86Juk1kpzABEhyKQvGbFm5D/zelw2tqvPdP4+Bb5CIACtYVCEDGTV1CTct/wsaIV3WfaCHCKcKCCvZV2QDGzhtIQcTd/QAjOBI7hWt62Xai7vbm5uCrxM9nN/9EngXo0rcG7fgi0Udauy3X6W178Dt9iq/Bjp8hVWQz+9XhQvUnZ1lImZeVOLhvSnQhoHUFt4I3I7dZamZj+Njln7k4ScQHBroDyUswzu8Uk3iKwW318RzLxL8xrnKOAS145HztBYdghmQpsomYv/JLL6CHyUqSOOTtGyblv/utugLDtwtxiXz23FigZgwQWE27QBisRn5A0ddmSUC5LegSgYxZPISblryB4ZdCcZkE5GydqJHs3izRuXXuMKKCPn9uWCDODRDITct+xPQp+zTVLzMqwOexa0HUtehZe1l87tS4IE4MVGRNu0EZLHfv46oCayHXDS/9WYaiPGSlGfTjjAWyx0f/4nL7j2pd6QOO8gsQ+S35JIOYtEs5dy0/d8eJ1iLpfkpzDBmLprfsjMNqCvPPw/vygtsw/0cjm78wBgxJl5SOkfCSbw2HMG1xscDemyDO9SjcPYYkYggUcIEwofzMh3p0GPrPG4xMYYHionWedCCCUYcatHwuo+1zJxJCww74sHZ7zsctuypoW17LBNfulqyYWzu4xwp4/fYYnMES7mABF7qxATz54CRBFT/o4vCrh6y30rFPo2IfZnIFfEJCuQoD/vwYrioMQFTOUPZGIPfEZLZnO8GPTSobqvQY9KTdP4ol5hAoT5KRNwKpLCSbvzdeUVQSrtuOgHM5kocviQ9Cq/gSIEI5sde4GNwjZAY+XVmrKGpdVUjhzU3I6PVe19I0x0jttML8iAfXvy6vbksrm6uPlx9DDvVpjJuOE2BK3bbhc2lMeGzIAVEkCAT3i4tiMlr/xfIoUV2cjCtrdnJQYCpv2zvHj6fD+vS3OVp6Iey9wvT3O9QJYIPUdp1cNzRmbp2bQTn/3/NnVt347iRxz8Mn/dkp7OZnX30RT3jnG7ba6lnkoccH4qCbGYoQsOL3c6n34MLQQAEwQKIUvbRtKp+rH8BIInrQrVuy31Zld3HCrbuAr2BduBglWwwi5936UKXb+ri0uzLviU4crNPhfE2Fr5SkG5hga+Xud/yMn4wcDBGL2cGCFDC0kWVvefl8vDmb+W/8hVLMEdzfCVNFKS2CpP4L2kbWb7zC4u9QRo3/lHsgy/2kAjjFb1CM/TlniGdnDx4YP+QsI7uIZqBL/QS9S1JXd76lsBKnDBk29XlZewAmA0X5ELz6aff52/lS/wp8G58rTv181O1YZI803Lqbecrqc6kaWdOCbxqmvxjG1L9pL/nwRLUpCbCZDn7q/XW7eDW202aa7h1afkpwsEHeQ483Rokojgmh5+EzMaW0oHlATz8OhtpWj7cVbuVx7zJTy3OzZy57+Xbic75lB45vMfXfBzzIpSpObPKwF9+NNaLJy1pGb8CORa2ZbvjFPFo0z6gmG/Tg2XJkv9BLFUu9nK5Kms2YJ6Gpnx5pptyq6gSbBEHX74CfG7IkQSNF/vC07zNBSgnNKXiDc7mcAj1JAMX1L4O26vWB1W+5mDsg+0zHU4uTgNlPo+0mZNZb5Deyb6lxe+ki5ba9oDzTeilAVoDpDgzdXW+9TfeHtnp4jPvjmyjbb4EmE/u2+ch9zgcWm46QEqFBwY7sR0jTL65OL/cjn7ny71w0ufVTV5V+6BpmPpdaA7wxbZhYLGThynF7vOqGP0CxH4ix+gbeCLHi0g8cELUTRHXqGnDvQHkDNwE3AJz64tIOpJCRE0V3Sise69zp7S/yl3s4uDc+iLSjqQQaVNFN0rr3vXPlrYiTVSozA5bTsUACrk6Fi6e9OKXrf2oi9AdR0bgaI0toUWCfPw/kdaAQT6bXDzpyPfNlFxJnkB2bWbnFlcahwOSYvGD/SVSabCAtSJ5jErk8+h1WeboBk4ZX0Lg4MY7YWhKV1jL3R9K+ljlH0FfTgo9WmPLapGAuiaNjivLrp0Hj15pr8lr/lbSRq76iLgBywOyxC4aTGacSJnce3m9VZ69kt+85vVLTB0ShsgCaxCYrinCYSoWgx+AeLfsUMxoJLe+iIwjKUTLVNGNqh6kR4C08dXDsL+IvOGNQPoYR5Gh1Z9WFYl9CRyNYXNR1c+vDvm50x8wRZW3bSBy4s68iR8+/aSFOv54U3dl95H4DgynvvtYUchMsWEHeLAxzrgPCg0n/Sx8T6QsSbwY6/4WynB9LJuABZEalltiNw8aBdgwJIlIqDh4WpKQ/RF2DqIOHazxpTRIYDkTRidlZdec5z1a0t7G9dzd4ndI3ob1RK4NhOl2AHQ63hJyXvtknPjAltLJA+qKFi9XnJBz0BvBRqw2CNtjRd2IZo0suU2CiZ02OiawXJ2xuIsMM+dvCTFcbogt6AgBaLn2NUrSwC9Oq15mJAz2IpMiS7xgDH68ZeJz0MpWxfqMtuZ4ioDVrLWBMMmOrjW6tmC0Kci38yHuaaRZY8tnkYAqJo2Oa8qu9WfIk5dP/QybvK3QyhZZVpMDEzVdXExQPo11cTcBdm57GbLBsSIyM2QRFQKm39pA+Lnz5cLWzNJgcyg7GtP1PBpfQDwNBJcwVWiDnGTw5xeVFnn1S9l2tIl5qOnm2MLaKKC0iQPk8rKLr8qnV2AxB+5w0zdtVHYNe2SJpyyYxuljZCqLeYKHYvDql5kcylx+i8fcgWaOLbKNAmqcOECuMLtYKJ/LAm+7huSn676sgraBNO/CcHIJsafAAMmRQlbyt/xfe+XfnwR6IDGvKdwOW2rFwO58FiTA5xr/YfxHqODoTnyfoEnSw4uF9OItCQ91EfMJwMyQy4FCwCrZ2kD4YezCx4JgcRh8ucLUWhOF0Mq3mkT8OHCn/TlOt7ivvrDh6x/jcNwUP0MjBrKcqk0VU1a2tCa5dDXHo9Lkri6q/kBiJpOZ1IFZjg7n2B1NFmtHAbEmLDCykLqJ00J6V5/7yNLDTfEL6YgBtyVJgpJCltKXV8hHyh/0EUhpiSyjToGpmCYipuFZefJLyM7IrrurvqPHsop53bA8YEvqoAGlRYmUSy2u56PnBcnp6RwXOzNEF1hBoLquD0eoKP14xfvfnvTkED2VXDeHzSO6ur/ZfNncPm///vX64UsKZFbkdUEqcnhuP0576ttqJD6NUyrgM2rznRS9PhgQ8h1lEAdXvu+pVWsQTBpoEULqosMK7R/8ImwdwhNhS5J3TfkStg52uAHDHrkVmLJgjUH6GJnKDb/aKa8LMtcH0rDduSLvYDRHF9lCQTVOG6BQmF18H3wuCPxHT9puxTJiywO6zFMadqeSzYTNBsBRVuSXX4cu0Vab88TcwmCLnVaDA6w6yeLiog4bDYHktItTGNhZflAk1UgBoiaLTgl7Hjx6pRVH90XTdXNkcScomLqpAxxPq5wReKRbK944K5DoWtL3n//z3z/85ZM7kbFrzzXri6QxdGV92ujGHIJW1m/L+qUiTV9Hv/taHrAldtDQP19sKOQLBk1bcVSgvA77uhBu2lcarzgzvkhqFQhYeRKGNior/QFE7VbktbtQbeng9SRpXKOeHaCMRs85v8zM+vD59Gki4iLCZsxLs9jF6Lr5ZcQMXWufOkBNW9CK+22/b4umPMe25po5vsAmCixw0gClwLpPr8C78hSTWGaGLKhCwIRcGwg/LUz48Ar2rSXN1Ys4lCMUpmyRpTM5MP3SxcWUZJ+N+Yvr6BJLzt/yrngV65diPqh0c2RRJyiYrqkD5Dujs4uF8ukXuKwP9D1y1dNojC2uCQJKmzA0seE8uzSznEuXdZjF5dyUnH8fsFk28Jvi/p5HS5DYyUCZ+KTphKdkg19uFmQH9Bta9aeoyEZL2HBiKlBW8L9xJLRZMAnlHv+fS1Id7uq2y4Pm4g1klxegtP4b8HdfefGgu5LdWkuKWMd0JL8r7n/p1qLLxawOkP6ZW7LvtUMTAb0zXqzwN+2f0Uvlbdmy3aDCjr4UVM0U51HkxgCEdAZF6v4UwpoN7ydDQC55THulDDHFMyEA6RKFkx3Zn87GVxcveKGQYKGugJoiALJNAoE0WwPDHY5jFODuqv7oXss64GBVQVKGmJKZEEh7Nw0HItvImQvLJd11Q/JD0fSnffsQ+GkvsRMPqGK6aRBVPZGCnygO/GL81pPlTrwkBQcuzFC11RAQQe1A4CpKkDsmW6/QrQ4kA3M7iikCNMxkBQLXa9gawhmTrRd/4gTHwq1Q1RoJELGsKOBaCYwzHmMMLmiQ2vANHJsWvw7bz0nn4O1U5aSAk2JGFJgYjpuNzy7Kd/VbXpWHuBKtG6PqOAFBpHSHBlfTgPpitTVl6/SvzmVwlNIOVUmdARFxEgtcvwE1E5dLtYczaQKPTtRgyhpdQZME1dERXZiaI9Ybr0vZwCNINair1yK9oiMFXCqLNVIKnubIOx1+/Fn8e62TOvc6a7GHk2bCpry6wcrXMvW1PKcAvpbnRZZVPqNhrtI6pW1p0wWfrugGDq6WmeYMs3igYyadSXukbcn3w+VFjNtU+gSdKLTbqe8+eCl/yzt9tjToHXCkji6Wuk3ZL3/J60NF1tGkjwAcK96BvcZuJncUAH7MX8raep7E00dvAbdgLxOKxzuXCfnQrN5Z2zDE05UzwDcHM3ui76GTCjW8skZ/qpok6JPVEV1YkzFivfHa7ylyd6DgSKUdSE22Q+pj3nRlHlpwBormAWksxwgIkrSJcPB0DagZEc0Hi/zNl/yD9lHPE5smPEGY29e8quh7Cqh05aX+1uTnc5JIDU8+5mNZ/M4apshiOZgDWjDWLfBzQ/tzeMEcLFFbLpMCqgDTiAJSpXCz8VlFktR9/HeAhQN1aLP9LCI6FIQZaq40BCRRdiBw2STIHZNDr7gP3sEQW7Owz91pOEG6yTf4mdiMsv1Qk7i3aOV89ABoiZhVv6/KIj5bozl6ziwUNHOuAMPyp4H9MU/qQdx44wUGGQNHFuOb22EMEdTOPr7S+iOuL3w0RdXNwoAWSzuCguunAedjtHV8ou+3eZcHRyftUBXUGaDjOBPEkpUNfT8IL3OgJ/p+F17sDEpD30v/Pmx3YRNkJQRvzq8NgCRkXQhZ6ZzTa/mfng0OegpyiuEA8BDcNYTcR8yCU4aoqTEgkPRMw4E3Ngo2F5vd0PzKxuTiRoxGU1T9LAxEQVdQcA014HyMlo5bIs/YipmNaRhjajkFAdRMHFrWDpdOwt98W7uLPtxTwG17TGmdLIC6KDFmXcjhpTuxm7jsvw7ZllzegmWPKrOLBZF5NkZwuzBBL8RttRC7h31LmreQbY0kdzBE1dWAQAQVBvm+CpygNJI0F0v9wInEyzo6+vFUiIfjsSVdfIWw7HET52CB8jcXI7xC2OiFuO0KEa/vZZQN19QREahKaBLOheZ4793FPjIu8TgMfQymiCXrQI87ttd2VBfFaIkqnUmBiOeICFTuRtJsaNOmWP3yibyUbRe6csIJHVzNFXpjFW5XVu3MctH8cPjWFaIZguvOPT7rtqD8JoVl+eHQdwUdvM3luiEn+kYScoXDebQuPd8BPKCXWTK5FUzStYBMeZgTMLhWThmQJaN5W5Rl6M5mEjWagkQ7NvR0/dGR9s+f1qIy5muvfM1peM6bllylizDjDvnVxY3bWtKUeVX+KylfOYXdQ0dT6d3RObX1wrTPW/Ljf/21DemkEcDRElSUeB6uU9FEWsXFf7aO3VO0rHZNWb+Ux490cOXScwO6yEVevJJtU4RyBzuQwEkgGf+r5V4SN3MmB9LQFa+Uhh5aKlnKEiZdKlAm/naekbpeQIsFl/BrX3XlueK2wS2aw0WAqChoKfNJ/uMofaPo7aCDhKenc96EHpIiwZotTOqUsExeWToFJlbVCS9Azs99VfErcdDBPETUlMhB2uPoE0ddkwoVmLbh7Z8wAwu6EpGNPhCEUxTAhgh9XYTM7jYhg/VyR0xBzx87elOV5z3Nm4BuhQFomAPTlByZsYsdLTSfydPnoILKfUPyjly9Bx4LIKm6MUzctLhMXMpnTiBYL+uUCNnAwQ4P0O/r4t25lbU6e4XNTd929LTLAzbB0JHKPCCLSZEykwW/2HGfKLm0qPAqcluGdKHqSGYZIGsCkBTzUDr6axPpOLLgEn5pxYTwyIqvzAPETIqUslbtSflE0daihgi8De+31EyDhE2AUoL6O2ZXiqloQUKylYyPDX0rg05ctsi6kzBxcfCj4Oxf59E/lvTTO4AnQa4eCd4NS78F00dACpDgMgHyVPlX5R1FfxcfLv92XdO5jWitkyKl1C12a72Nba238U3oNrC1ToJSgiK21tuY1nqborncRrfWaPhR8Eu01s47CEhCAg1iE4CBHsS/iPRrhOf7Ua2L3nARIDwKWgrPT13AFt5BhwsvNuZe9YZguAgQHgUthRebiyO/mjjoEOEPeTecfRAEHexgEvdNQ+ru1tgS5Si7LMEkzYtJ/VEXUf7KPBMiljU968JgmQEVVd62cOGmcfzw6Sfd+dVu87z52+PTSHjLm5LNQIUzBh8m6M+fbM7jl6ubzS8PX243q3GaKw/1IBrp03lFkpQPT4r4qP7Kgqd8LHFWFjrlw8NRkz9WxmT4gfBWxmb48fBMTGCVmvo2q9Tu7uvqKqV8eAo3/02aKmW78lDZ79dWKeVjkiLjoUHI+XOVBz+pBjvgjNQEkIz9dRReEj92bQ7gWUvfa3Z+9nWV178H43RjnCm9cyDACE3i0LLh0l76mxeVNA1twpbsCqoyxBTThACETBROxv90rkHWxTuSrngN2mtEwAY7TOkMBkC5JLFk/K+ce5kdqWc/2TB9E6CI9OPJUZV3UfNwlCFqlgwIJE1pwsnYn+4JRYZ4tDnl3dWJ9iGnm0mgZosqoc2BqJgyrkxcyQdvS3Juu/CSPxjiCzlAwCquDkfq13YLFZn/ahcx82u0xJdvtzjJCyEiqaBzBpsu4QthG4SWFXuF5mtxgieATj1gSjpDA0iLFmn2Qrp8uH4cPHsl31TkxA59aujpb4/sFsLvxHaBLLoTB1MdK1imOxH/YOtWvp+Fb7/w7OXgK2nb/CW4g84yxxbcRgHFThwgF5ldPCmfXoFFvYh6lzOtkeW1STB100bHtBXtxfI762D+K+vuCH9DscwvIa6OClA3YYBK3zflc0HgqiPNTcwboGmNLq9JgqqbMjqhLbtWLL7jvpDuZ1KTtmytzjQwXTdHFneCgqmbOkCm74u42EqfXoHv6pLtqBzTz2FaI8trk2Dqpo2OaVuKa4v9Odx8PLkm5p3RsEeX12ZBBU4doxCZX4W9E38lhzK/oXXMQh7LHFnkCQqmceoAmcIndrFQPv0CU/aqHNtCadbY8lokyGdzQ09pw+NL4U/8orv9RZSWJxaEbk0iZH2TxWsdCXWscXoh3RPtO2Ie+gKOUNkiFx2TA6uW6eJieWvYlVJ489ZGbhq3f4FpfQlJ9T0L4KImi04Ju7g1w932veyK1zXp1Llly91B8rmbjhWDuTv3GHHyXJocYLuaLjDeprLxcECLmpD6Qrp5qJVF3rvEuplkj1ME3XaBnFMnDlZJsYJlivPeOJZvonzPC/9K8rfg0StuhCnuCADIuTKEbLD3iESPc9teHTvSsA+aYD49PitjkJQJUZnuK/FMEgcNsCZWHjXzOWzbYBdxdGWpaq+LZfutBC/fZixhCZsrmgKSKS8IqdI5oLnNeV2Qytx8NIQ2WAPlSwjLDG9zUt5c3d9svmxun7d//3r98CUdlxye24/TnlZYeTShF6hzGhJa6Q5kT/u6iErnYAt87iQCZZonhLTZrMWk3VQkb8waEZQ0BRw9+VNGvpPiTGkVE91gi/qqYHMg89JSxZRpntDqmSJCa1lFi+BpiwzE7LBTpRiANK2OI5Me5h9nJ3KiQWdyjBRpii2YjgFo9vNm9/zr1Zdvm+evV4/hU7V1ouHKM1V7dZs0AH1Nko6jddfolTcSJtx4UU/kuBbzRI4+RKICmI1+5gs73be0Il0UbLDFLu4GB1Dek8WUaZ7mJfyjJ33cC72wBMmX4B1Uo13m/VMHXuDdU+J8T8TEScuUl/nS0ZAufL0l43BD7Ko1Qi6RIUGDJSiBbtngYz47bVm/VKTpg/e3ZSRljJ0lE3SJT4KRCHsAJ9Qx033NBbjL26jXQAvVCTdL5aN9pSvyxqwvU0IU6XJFhCNDykgiLTPD21ICuzLuq2G0vkwCFelyCeTIkAQm0jIzvM0nkI0VGYeWw4nSFDt1OgaQt0QBZaOf2Uby7uvm4dtuxSujCzj3ymgkrfko8q4InlvOmdIWPW06B5K3VDFlmiePhF1UV1TXofesDYhLtFGMBWucVuqVCfv5fLB9VT/T5j5ithjjaObY+bFRgDwlDi5jF460qd3T4HRZy1afqxgzo3TqAVPgGRpAY7RI2RHA2szOxTm0ZfsQeLrXgH9APKnMwQCJmiCWrGzp8kllVdl2n16aMrjTQBliCmdCIB3pacLJdD8e8Wh+2BZNeQ4PTFmiymdSQAMRiSLK2N/t4MkzLJGX9Q2twpc6KUNMAU0IQL9E4WTsz0L68YnHFyM659DUwVWAeXvOa1iFXus/Ew4S98+aCMgsj2PZtHEYbolb+AwKZCZlgmCywYlnklgePN+WQ15z1HnEBgMym25lGJlwMK/TP2kZ3HPICcwQXSkFAUi1PpJMuvA8TPPIsssM0dVSEMhDdHUkmXThbfrDP9o55ITdDWFRQE/N9cFkp8XOhzq8j5ZDatyeboMBUGttGFm90Lsc8/bSvT5jv4qNCMho+aoYsoUXr67pSRU8jscJwhRdKQ0D6gVMEU+m3Pj6Rk5vb6eZl9YbWlXEOk4LeCtvb6fn0Rw2+SApLSt0d6nfa13A5bRu6q7sPu5p95n29SFqRwknmXC/Ne2OzK97XwljGtNgfnXIz3EHQtn3MXXq60Z92jw83W6eJmMG0MliNt30N5kx9o9JDqJkF6awsvzL1f3Pm+fbzfXDt/ubTWSEEmg580yIk79cJasJnVE0TQ3SBAXXntUgMriZrR82KKxSSNads7SYk/zET1ZWQpMHqnyfnzbbX5KUEtOXt+J9pQcSPHjCWdxyXbWLomXFa16/kGfARPyZircKizVpzsYBBtj4r1eWU0E0XPlKaYrikp2kk7nA5qpCHK0hx4a0r/ND1+bHT3MSO3lHDIcZxpjvrlMQ6IMoaWiZutS5R/r0OblsgCW4G0maYQqpI0CTi1cHko0+PILR858eKa/IwSx6fpamIOHE+RqJYPJIkLPylriNnPAgfdf0TOqonbuVIWoJNCCQMpgmnIz9ubwBOT+1ge/F8K0JbvcNY0wRpyCAkIlDy/glvjVG3/ink5wb8kbq7rqh7y1p5Kk22/fyTH4mbdc3JLiFWfaIKj+MDsnJv0uZTP5uL34njzNq2e9eRrIvpfRUtuJkrvBbHG1x02RxQAlJGFcmr7TS2wKUn7aVDPomvXlWa+T1gZ62XVPWwWdU67aYOZxwADlMGlcmrrSDN9/iFza54TFi89vRElVKkwIRMlVEmfj7vLSJb0NO9I1svndNvj2zL7pwruUAV1AXDKQrSpiZuEzY5XbwuyT2tt+3cTXFNMcX2kSBZU4aoJS41Xz6BD5XebHmBkx7XIkdLJDGCDFm8ipQZjbasCuL38OrkbJEldakQERNFVHG/+6kJ4+E32eG3q7Ja/5W0mbbR808bb4/Wx5AQuNQs7282PbuCbCrP9fnwMsZ382GDO7ddMBtr9OOTmNIin0PbE5lF9Ex0nx/1s1Rq5MDBRm2SRxdxj+fiHI4X7ke9i1p3qKogymyngYGoOWXu+1uc/9883B/v7nZhQ/d6EjTl2eET/7w9m6bkju686BTZZBtsTA4mm0JprCQJkDxdjNlx6r0D2fS5F34BACGkqbYhVPHAApnqohYh+HgaL5yb2nfhO+y1Xx/FobI2mkQgHIpYsnawYlHs+jHeshLxArVwp7dacLJlt9Ktt+u/7q52T1vft3cx7V+A9Dw5Gn4dqteR9RriOf1w1i+XuQVeYqQUhkGjABt08DkCBC/2KC8VFq85fKYSMZsPqZJ0nZ0G7GHk2Yamrg0QD15HW1d20elSZ/OBCYwUYS+2Iw0VoQE73fNjTAb4xEAkW1dCNlg75nfS07nih9TH/x2oZliCmZjIJN80wWVDReWDs/saOw45GiJKiMNHVxNFlHWUdCYake/dcVtxCiVMsQVUIeA9EsSTtbRvisOruE2x/4GX+lbME8zxRTQxsD3NUgR1LCnwUn48ghJm8Nn2gQfeDHYoUqoMyD6pYglY38dhRffvLu3krz/qW/Jw5nUt7Tow85AYNbPljWOlLMkgKDpw8v6lrB5PIfR5UXg/z6t/19oH5eLf1hF/reyPtD3+e9W8X/P16jtYPItKn7wHz84PzT/D1piRkY="
assets/search.js ADDED
The diff for this file is too large to render. See raw diff
 
assets/style.css ADDED
@@ -0,0 +1,1611 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ @layer typedoc {
2
+ :root {
3
+ /* Light */
4
+ --light-color-background: #f2f4f8;
5
+ --light-color-background-secondary: #eff0f1;
6
+ --light-color-warning-text: #222;
7
+ --light-color-background-warning: #e6e600;
8
+ --light-color-accent: #c5c7c9;
9
+ --light-color-active-menu-item: var(--light-color-accent);
10
+ --light-color-text: #222;
11
+ --light-color-text-aside: #6e6e6e;
12
+
13
+ --light-color-icon-background: var(--light-color-background);
14
+ --light-color-icon-text: var(--light-color-text);
15
+
16
+ --light-color-comment-tag-text: var(--light-color-text);
17
+ --light-color-comment-tag: var(--light-color-background);
18
+
19
+ --light-color-link: #1f70c2;
20
+ --light-color-focus-outline: #3584e4;
21
+
22
+ --light-color-ts-keyword: #056bd6;
23
+ --light-color-ts-project: #b111c9;
24
+ --light-color-ts-module: var(--light-color-ts-project);
25
+ --light-color-ts-namespace: var(--light-color-ts-project);
26
+ --light-color-ts-enum: #7e6f15;
27
+ --light-color-ts-enum-member: var(--light-color-ts-enum);
28
+ --light-color-ts-variable: #4760ec;
29
+ --light-color-ts-function: #572be7;
30
+ --light-color-ts-class: #1f70c2;
31
+ --light-color-ts-interface: #108024;
32
+ --light-color-ts-constructor: var(--light-color-ts-class);
33
+ --light-color-ts-property: #9f5f30;
34
+ --light-color-ts-method: #be3989;
35
+ --light-color-ts-reference: #ff4d82;
36
+ --light-color-ts-call-signature: var(--light-color-ts-method);
37
+ --light-color-ts-index-signature: var(--light-color-ts-property);
38
+ --light-color-ts-constructor-signature: var(
39
+ --light-color-ts-constructor
40
+ );
41
+ --light-color-ts-parameter: var(--light-color-ts-variable);
42
+ /* type literal not included as links will never be generated to it */
43
+ --light-color-ts-type-parameter: #a55c0e;
44
+ --light-color-ts-accessor: #c73c3c;
45
+ --light-color-ts-get-signature: var(--light-color-ts-accessor);
46
+ --light-color-ts-set-signature: var(--light-color-ts-accessor);
47
+ --light-color-ts-type-alias: #d51270;
48
+ /* reference not included as links will be colored with the kind that it points to */
49
+ --light-color-document: #000000;
50
+
51
+ --light-color-alert-note: #0969d9;
52
+ --light-color-alert-tip: #1a7f37;
53
+ --light-color-alert-important: #8250df;
54
+ --light-color-alert-warning: #9a6700;
55
+ --light-color-alert-caution: #cf222e;
56
+
57
+ --light-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23000' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
58
+ --light-color-scheme: light;
59
+
60
+ /* Dark */
61
+ --dark-color-background: #2b2e33;
62
+ --dark-color-background-secondary: #1e2024;
63
+ --dark-color-background-warning: #bebe00;
64
+ --dark-color-warning-text: #222;
65
+ --dark-color-accent: #9096a2;
66
+ --dark-color-active-menu-item: #5d5d6a;
67
+ --dark-color-text: #f5f5f5;
68
+ --dark-color-text-aside: #dddddd;
69
+
70
+ --dark-color-icon-background: var(--dark-color-background-secondary);
71
+ --dark-color-icon-text: var(--dark-color-text);
72
+
73
+ --dark-color-comment-tag-text: var(--dark-color-text);
74
+ --dark-color-comment-tag: var(--dark-color-background);
75
+
76
+ --dark-color-link: #00aff4;
77
+ --dark-color-focus-outline: #4c97f2;
78
+
79
+ --dark-color-ts-keyword: #3399ff;
80
+ --dark-color-ts-project: #e358ff;
81
+ --dark-color-ts-module: var(--dark-color-ts-project);
82
+ --dark-color-ts-namespace: var(--dark-color-ts-project);
83
+ --dark-color-ts-enum: #f4d93e;
84
+ --dark-color-ts-enum-member: var(--dark-color-ts-enum);
85
+ --dark-color-ts-variable: #798dff;
86
+ --dark-color-ts-function: #a280ff;
87
+ --dark-color-ts-class: #8ac4ff;
88
+ --dark-color-ts-interface: #6cff87;
89
+ --dark-color-ts-constructor: var(--dark-color-ts-class);
90
+ --dark-color-ts-property: #ff984d;
91
+ --dark-color-ts-method: #ff4db8;
92
+ --dark-color-ts-reference: #ff4d82;
93
+ --dark-color-ts-call-signature: var(--dark-color-ts-method);
94
+ --dark-color-ts-index-signature: var(--dark-color-ts-property);
95
+ --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor);
96
+ --dark-color-ts-parameter: var(--dark-color-ts-variable);
97
+ /* type literal not included as links will never be generated to it */
98
+ --dark-color-ts-type-parameter: #e07d13;
99
+ --dark-color-ts-accessor: #ff6060;
100
+ --dark-color-ts-get-signature: var(--dark-color-ts-accessor);
101
+ --dark-color-ts-set-signature: var(--dark-color-ts-accessor);
102
+ --dark-color-ts-type-alias: #ff6492;
103
+ /* reference not included as links will be colored with the kind that it points to */
104
+ --dark-color-document: #ffffff;
105
+
106
+ --dark-color-alert-note: #0969d9;
107
+ --dark-color-alert-tip: #1a7f37;
108
+ --dark-color-alert-important: #8250df;
109
+ --dark-color-alert-warning: #9a6700;
110
+ --dark-color-alert-caution: #cf222e;
111
+
112
+ --dark-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23fff' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
113
+ --dark-color-scheme: dark;
114
+ }
115
+
116
+ @media (prefers-color-scheme: light) {
117
+ :root {
118
+ --color-background: var(--light-color-background);
119
+ --color-background-secondary: var(
120
+ --light-color-background-secondary
121
+ );
122
+ --color-background-warning: var(--light-color-background-warning);
123
+ --color-warning-text: var(--light-color-warning-text);
124
+ --color-accent: var(--light-color-accent);
125
+ --color-active-menu-item: var(--light-color-active-menu-item);
126
+ --color-text: var(--light-color-text);
127
+ --color-text-aside: var(--light-color-text-aside);
128
+
129
+ --color-icon-background: var(--light-color-icon-background);
130
+ --color-icon-text: var(--light-color-icon-text);
131
+
132
+ --color-comment-tag-text: var(--light-color-text);
133
+ --color-comment-tag: var(--light-color-background);
134
+
135
+ --color-link: var(--light-color-link);
136
+ --color-focus-outline: var(--light-color-focus-outline);
137
+
138
+ --color-ts-keyword: var(--light-color-ts-keyword);
139
+ --color-ts-project: var(--light-color-ts-project);
140
+ --color-ts-module: var(--light-color-ts-module);
141
+ --color-ts-namespace: var(--light-color-ts-namespace);
142
+ --color-ts-enum: var(--light-color-ts-enum);
143
+ --color-ts-enum-member: var(--light-color-ts-enum-member);
144
+ --color-ts-variable: var(--light-color-ts-variable);
145
+ --color-ts-function: var(--light-color-ts-function);
146
+ --color-ts-class: var(--light-color-ts-class);
147
+ --color-ts-interface: var(--light-color-ts-interface);
148
+ --color-ts-constructor: var(--light-color-ts-constructor);
149
+ --color-ts-property: var(--light-color-ts-property);
150
+ --color-ts-method: var(--light-color-ts-method);
151
+ --color-ts-reference: var(--light-color-ts-reference);
152
+ --color-ts-call-signature: var(--light-color-ts-call-signature);
153
+ --color-ts-index-signature: var(--light-color-ts-index-signature);
154
+ --color-ts-constructor-signature: var(
155
+ --light-color-ts-constructor-signature
156
+ );
157
+ --color-ts-parameter: var(--light-color-ts-parameter);
158
+ --color-ts-type-parameter: var(--light-color-ts-type-parameter);
159
+ --color-ts-accessor: var(--light-color-ts-accessor);
160
+ --color-ts-get-signature: var(--light-color-ts-get-signature);
161
+ --color-ts-set-signature: var(--light-color-ts-set-signature);
162
+ --color-ts-type-alias: var(--light-color-ts-type-alias);
163
+ --color-document: var(--light-color-document);
164
+
165
+ --color-alert-note: var(--light-color-alert-note);
166
+ --color-alert-tip: var(--light-color-alert-tip);
167
+ --color-alert-important: var(--light-color-alert-important);
168
+ --color-alert-warning: var(--light-color-alert-warning);
169
+ --color-alert-caution: var(--light-color-alert-caution);
170
+
171
+ --external-icon: var(--light-external-icon);
172
+ --color-scheme: var(--light-color-scheme);
173
+ }
174
+ }
175
+
176
+ @media (prefers-color-scheme: dark) {
177
+ :root {
178
+ --color-background: var(--dark-color-background);
179
+ --color-background-secondary: var(
180
+ --dark-color-background-secondary
181
+ );
182
+ --color-background-warning: var(--dark-color-background-warning);
183
+ --color-warning-text: var(--dark-color-warning-text);
184
+ --color-accent: var(--dark-color-accent);
185
+ --color-active-menu-item: var(--dark-color-active-menu-item);
186
+ --color-text: var(--dark-color-text);
187
+ --color-text-aside: var(--dark-color-text-aside);
188
+
189
+ --color-icon-background: var(--dark-color-icon-background);
190
+ --color-icon-text: var(--dark-color-icon-text);
191
+
192
+ --color-comment-tag-text: var(--dark-color-text);
193
+ --color-comment-tag: var(--dark-color-background);
194
+
195
+ --color-link: var(--dark-color-link);
196
+ --color-focus-outline: var(--dark-color-focus-outline);
197
+
198
+ --color-ts-keyword: var(--dark-color-ts-keyword);
199
+ --color-ts-project: var(--dark-color-ts-project);
200
+ --color-ts-module: var(--dark-color-ts-module);
201
+ --color-ts-namespace: var(--dark-color-ts-namespace);
202
+ --color-ts-enum: var(--dark-color-ts-enum);
203
+ --color-ts-enum-member: var(--dark-color-ts-enum-member);
204
+ --color-ts-variable: var(--dark-color-ts-variable);
205
+ --color-ts-function: var(--dark-color-ts-function);
206
+ --color-ts-class: var(--dark-color-ts-class);
207
+ --color-ts-interface: var(--dark-color-ts-interface);
208
+ --color-ts-constructor: var(--dark-color-ts-constructor);
209
+ --color-ts-property: var(--dark-color-ts-property);
210
+ --color-ts-method: var(--dark-color-ts-method);
211
+ --color-ts-reference: var(--dark-color-ts-reference);
212
+ --color-ts-call-signature: var(--dark-color-ts-call-signature);
213
+ --color-ts-index-signature: var(--dark-color-ts-index-signature);
214
+ --color-ts-constructor-signature: var(
215
+ --dark-color-ts-constructor-signature
216
+ );
217
+ --color-ts-parameter: var(--dark-color-ts-parameter);
218
+ --color-ts-type-parameter: var(--dark-color-ts-type-parameter);
219
+ --color-ts-accessor: var(--dark-color-ts-accessor);
220
+ --color-ts-get-signature: var(--dark-color-ts-get-signature);
221
+ --color-ts-set-signature: var(--dark-color-ts-set-signature);
222
+ --color-ts-type-alias: var(--dark-color-ts-type-alias);
223
+ --color-document: var(--dark-color-document);
224
+
225
+ --color-alert-note: var(--dark-color-alert-note);
226
+ --color-alert-tip: var(--dark-color-alert-tip);
227
+ --color-alert-important: var(--dark-color-alert-important);
228
+ --color-alert-warning: var(--dark-color-alert-warning);
229
+ --color-alert-caution: var(--dark-color-alert-caution);
230
+
231
+ --external-icon: var(--dark-external-icon);
232
+ --color-scheme: var(--dark-color-scheme);
233
+ }
234
+ }
235
+
236
+ html {
237
+ color-scheme: var(--color-scheme);
238
+ }
239
+
240
+ body {
241
+ margin: 0;
242
+ }
243
+
244
+ :root[data-theme="light"] {
245
+ --color-background: var(--light-color-background);
246
+ --color-background-secondary: var(--light-color-background-secondary);
247
+ --color-background-warning: var(--light-color-background-warning);
248
+ --color-warning-text: var(--light-color-warning-text);
249
+ --color-icon-background: var(--light-color-icon-background);
250
+ --color-accent: var(--light-color-accent);
251
+ --color-active-menu-item: var(--light-color-active-menu-item);
252
+ --color-text: var(--light-color-text);
253
+ --color-text-aside: var(--light-color-text-aside);
254
+ --color-icon-text: var(--light-color-icon-text);
255
+
256
+ --color-comment-tag-text: var(--light-color-text);
257
+ --color-comment-tag: var(--light-color-background);
258
+
259
+ --color-link: var(--light-color-link);
260
+ --color-focus-outline: var(--light-color-focus-outline);
261
+
262
+ --color-ts-keyword: var(--light-color-ts-keyword);
263
+ --color-ts-project: var(--light-color-ts-project);
264
+ --color-ts-module: var(--light-color-ts-module);
265
+ --color-ts-namespace: var(--light-color-ts-namespace);
266
+ --color-ts-enum: var(--light-color-ts-enum);
267
+ --color-ts-enum-member: var(--light-color-ts-enum-member);
268
+ --color-ts-variable: var(--light-color-ts-variable);
269
+ --color-ts-function: var(--light-color-ts-function);
270
+ --color-ts-class: var(--light-color-ts-class);
271
+ --color-ts-interface: var(--light-color-ts-interface);
272
+ --color-ts-constructor: var(--light-color-ts-constructor);
273
+ --color-ts-property: var(--light-color-ts-property);
274
+ --color-ts-method: var(--light-color-ts-method);
275
+ --color-ts-reference: var(--light-color-ts-reference);
276
+ --color-ts-call-signature: var(--light-color-ts-call-signature);
277
+ --color-ts-index-signature: var(--light-color-ts-index-signature);
278
+ --color-ts-constructor-signature: var(
279
+ --light-color-ts-constructor-signature
280
+ );
281
+ --color-ts-parameter: var(--light-color-ts-parameter);
282
+ --color-ts-type-parameter: var(--light-color-ts-type-parameter);
283
+ --color-ts-accessor: var(--light-color-ts-accessor);
284
+ --color-ts-get-signature: var(--light-color-ts-get-signature);
285
+ --color-ts-set-signature: var(--light-color-ts-set-signature);
286
+ --color-ts-type-alias: var(--light-color-ts-type-alias);
287
+ --color-document: var(--light-color-document);
288
+
289
+ --color-note: var(--light-color-note);
290
+ --color-tip: var(--light-color-tip);
291
+ --color-important: var(--light-color-important);
292
+ --color-warning: var(--light-color-warning);
293
+ --color-caution: var(--light-color-caution);
294
+
295
+ --external-icon: var(--light-external-icon);
296
+ --color-scheme: var(--light-color-scheme);
297
+ }
298
+
299
+ :root[data-theme="dark"] {
300
+ --color-background: var(--dark-color-background);
301
+ --color-background-secondary: var(--dark-color-background-secondary);
302
+ --color-background-warning: var(--dark-color-background-warning);
303
+ --color-warning-text: var(--dark-color-warning-text);
304
+ --color-icon-background: var(--dark-color-icon-background);
305
+ --color-accent: var(--dark-color-accent);
306
+ --color-active-menu-item: var(--dark-color-active-menu-item);
307
+ --color-text: var(--dark-color-text);
308
+ --color-text-aside: var(--dark-color-text-aside);
309
+ --color-icon-text: var(--dark-color-icon-text);
310
+
311
+ --color-comment-tag-text: var(--dark-color-text);
312
+ --color-comment-tag: var(--dark-color-background);
313
+
314
+ --color-link: var(--dark-color-link);
315
+ --color-focus-outline: var(--dark-color-focus-outline);
316
+
317
+ --color-ts-keyword: var(--dark-color-ts-keyword);
318
+ --color-ts-project: var(--dark-color-ts-project);
319
+ --color-ts-module: var(--dark-color-ts-module);
320
+ --color-ts-namespace: var(--dark-color-ts-namespace);
321
+ --color-ts-enum: var(--dark-color-ts-enum);
322
+ --color-ts-enum-member: var(--dark-color-ts-enum-member);
323
+ --color-ts-variable: var(--dark-color-ts-variable);
324
+ --color-ts-function: var(--dark-color-ts-function);
325
+ --color-ts-class: var(--dark-color-ts-class);
326
+ --color-ts-interface: var(--dark-color-ts-interface);
327
+ --color-ts-constructor: var(--dark-color-ts-constructor);
328
+ --color-ts-property: var(--dark-color-ts-property);
329
+ --color-ts-method: var(--dark-color-ts-method);
330
+ --color-ts-reference: var(--dark-color-ts-reference);
331
+ --color-ts-call-signature: var(--dark-color-ts-call-signature);
332
+ --color-ts-index-signature: var(--dark-color-ts-index-signature);
333
+ --color-ts-constructor-signature: var(
334
+ --dark-color-ts-constructor-signature
335
+ );
336
+ --color-ts-parameter: var(--dark-color-ts-parameter);
337
+ --color-ts-type-parameter: var(--dark-color-ts-type-parameter);
338
+ --color-ts-accessor: var(--dark-color-ts-accessor);
339
+ --color-ts-get-signature: var(--dark-color-ts-get-signature);
340
+ --color-ts-set-signature: var(--dark-color-ts-set-signature);
341
+ --color-ts-type-alias: var(--dark-color-ts-type-alias);
342
+ --color-document: var(--dark-color-document);
343
+
344
+ --color-note: var(--dark-color-note);
345
+ --color-tip: var(--dark-color-tip);
346
+ --color-important: var(--dark-color-important);
347
+ --color-warning: var(--dark-color-warning);
348
+ --color-caution: var(--dark-color-caution);
349
+
350
+ --external-icon: var(--dark-external-icon);
351
+ --color-scheme: var(--dark-color-scheme);
352
+ }
353
+
354
+ *:focus-visible,
355
+ .tsd-accordion-summary:focus-visible svg {
356
+ outline: 2px solid var(--color-focus-outline);
357
+ }
358
+
359
+ .always-visible,
360
+ .always-visible .tsd-signatures {
361
+ display: inherit !important;
362
+ }
363
+
364
+ h1,
365
+ h2,
366
+ h3,
367
+ h4,
368
+ h5,
369
+ h6 {
370
+ line-height: 1.2;
371
+ }
372
+
373
+ h1 {
374
+ font-size: 1.875rem;
375
+ margin: 0.67rem 0;
376
+ }
377
+
378
+ h2 {
379
+ font-size: 1.5rem;
380
+ margin: 0.83rem 0;
381
+ }
382
+
383
+ h3 {
384
+ font-size: 1.25rem;
385
+ margin: 1rem 0;
386
+ }
387
+
388
+ h4 {
389
+ font-size: 1.05rem;
390
+ margin: 1.33rem 0;
391
+ }
392
+
393
+ h5 {
394
+ font-size: 1rem;
395
+ margin: 1.5rem 0;
396
+ }
397
+
398
+ h6 {
399
+ font-size: 0.875rem;
400
+ margin: 2.33rem 0;
401
+ }
402
+
403
+ dl,
404
+ menu,
405
+ ol,
406
+ ul {
407
+ margin: 1em 0;
408
+ }
409
+
410
+ dd {
411
+ margin: 0 0 0 34px;
412
+ }
413
+
414
+ .container {
415
+ max-width: 1700px;
416
+ padding: 0 2rem;
417
+ }
418
+
419
+ /* Footer */
420
+ footer {
421
+ border-top: 1px solid var(--color-accent);
422
+ padding-top: 1rem;
423
+ padding-bottom: 1rem;
424
+ max-height: 3.5rem;
425
+ }
426
+ footer > p {
427
+ margin: 0 1em;
428
+ }
429
+
430
+ .container-main {
431
+ margin: 0 auto;
432
+ /* toolbar, footer, margin */
433
+ min-height: calc(100vh - 41px - 56px - 4rem);
434
+ }
435
+
436
+ @keyframes fade-in {
437
+ from {
438
+ opacity: 0;
439
+ }
440
+ to {
441
+ opacity: 1;
442
+ }
443
+ }
444
+ @keyframes fade-out {
445
+ from {
446
+ opacity: 1;
447
+ visibility: visible;
448
+ }
449
+ to {
450
+ opacity: 0;
451
+ }
452
+ }
453
+ @keyframes fade-in-delayed {
454
+ 0% {
455
+ opacity: 0;
456
+ }
457
+ 33% {
458
+ opacity: 0;
459
+ }
460
+ 100% {
461
+ opacity: 1;
462
+ }
463
+ }
464
+ @keyframes fade-out-delayed {
465
+ 0% {
466
+ opacity: 1;
467
+ visibility: visible;
468
+ }
469
+ 66% {
470
+ opacity: 0;
471
+ }
472
+ 100% {
473
+ opacity: 0;
474
+ }
475
+ }
476
+ @keyframes pop-in-from-right {
477
+ from {
478
+ transform: translate(100%, 0);
479
+ }
480
+ to {
481
+ transform: translate(0, 0);
482
+ }
483
+ }
484
+ @keyframes pop-out-to-right {
485
+ from {
486
+ transform: translate(0, 0);
487
+ visibility: visible;
488
+ }
489
+ to {
490
+ transform: translate(100%, 0);
491
+ }
492
+ }
493
+ body {
494
+ background: var(--color-background);
495
+ font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans",
496
+ Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
497
+ font-size: 16px;
498
+ color: var(--color-text);
499
+ }
500
+
501
+ a {
502
+ color: var(--color-link);
503
+ text-decoration: none;
504
+ }
505
+ a:hover {
506
+ text-decoration: underline;
507
+ }
508
+ a.external[target="_blank"] {
509
+ background-image: var(--external-icon);
510
+ background-position: top 3px right;
511
+ background-repeat: no-repeat;
512
+ padding-right: 13px;
513
+ }
514
+ a.tsd-anchor-link {
515
+ color: var(--color-text);
516
+ }
517
+
518
+ code,
519
+ pre {
520
+ font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
521
+ padding: 0.2em;
522
+ margin: 0;
523
+ font-size: 0.875rem;
524
+ border-radius: 0.8em;
525
+ }
526
+
527
+ pre {
528
+ position: relative;
529
+ white-space: pre-wrap;
530
+ word-wrap: break-word;
531
+ padding: 10px;
532
+ border: 1px solid var(--color-accent);
533
+ margin-bottom: 8px;
534
+ }
535
+ pre code {
536
+ padding: 0;
537
+ font-size: 100%;
538
+ }
539
+ pre > button {
540
+ position: absolute;
541
+ top: 10px;
542
+ right: 10px;
543
+ opacity: 0;
544
+ transition: opacity 0.1s;
545
+ box-sizing: border-box;
546
+ }
547
+ pre:hover > button,
548
+ pre > button.visible {
549
+ opacity: 1;
550
+ }
551
+
552
+ blockquote {
553
+ margin: 1em 0;
554
+ padding-left: 1em;
555
+ border-left: 4px solid gray;
556
+ }
557
+
558
+ .tsd-typography {
559
+ line-height: 1.333em;
560
+ }
561
+ .tsd-typography ul {
562
+ list-style: square;
563
+ padding: 0 0 0 20px;
564
+ margin: 0;
565
+ }
566
+ .tsd-typography .tsd-index-panel h3,
567
+ .tsd-index-panel .tsd-typography h3,
568
+ .tsd-typography h4,
569
+ .tsd-typography h5,
570
+ .tsd-typography h6 {
571
+ font-size: 1em;
572
+ }
573
+ .tsd-typography h5,
574
+ .tsd-typography h6 {
575
+ font-weight: normal;
576
+ }
577
+ .tsd-typography p,
578
+ .tsd-typography ul,
579
+ .tsd-typography ol {
580
+ margin: 1em 0;
581
+ }
582
+ .tsd-typography table {
583
+ border-collapse: collapse;
584
+ border: none;
585
+ }
586
+ .tsd-typography td,
587
+ .tsd-typography th {
588
+ padding: 6px 13px;
589
+ border: 1px solid var(--color-accent);
590
+ }
591
+ .tsd-typography thead,
592
+ .tsd-typography tr:nth-child(even) {
593
+ background-color: var(--color-background-secondary);
594
+ }
595
+
596
+ .tsd-alert {
597
+ padding: 8px 16px;
598
+ margin-bottom: 16px;
599
+ border-left: 0.25em solid var(--alert-color);
600
+ }
601
+ .tsd-alert blockquote > :last-child,
602
+ .tsd-alert > :last-child {
603
+ margin-bottom: 0;
604
+ }
605
+ .tsd-alert-title {
606
+ color: var(--alert-color);
607
+ display: inline-flex;
608
+ align-items: center;
609
+ }
610
+ .tsd-alert-title span {
611
+ margin-left: 4px;
612
+ }
613
+
614
+ .tsd-alert-note {
615
+ --alert-color: var(--color-alert-note);
616
+ }
617
+ .tsd-alert-tip {
618
+ --alert-color: var(--color-alert-tip);
619
+ }
620
+ .tsd-alert-important {
621
+ --alert-color: var(--color-alert-important);
622
+ }
623
+ .tsd-alert-warning {
624
+ --alert-color: var(--color-alert-warning);
625
+ }
626
+ .tsd-alert-caution {
627
+ --alert-color: var(--color-alert-caution);
628
+ }
629
+
630
+ .tsd-breadcrumb {
631
+ margin: 0;
632
+ padding: 0;
633
+ color: var(--color-text-aside);
634
+ }
635
+ .tsd-breadcrumb a {
636
+ color: var(--color-text-aside);
637
+ text-decoration: none;
638
+ }
639
+ .tsd-breadcrumb a:hover {
640
+ text-decoration: underline;
641
+ }
642
+ .tsd-breadcrumb li {
643
+ display: inline;
644
+ }
645
+ .tsd-breadcrumb li:after {
646
+ content: " / ";
647
+ }
648
+
649
+ .tsd-comment-tags {
650
+ display: flex;
651
+ flex-direction: column;
652
+ }
653
+ dl.tsd-comment-tag-group {
654
+ display: flex;
655
+ align-items: center;
656
+ overflow: hidden;
657
+ margin: 0.5em 0;
658
+ }
659
+ dl.tsd-comment-tag-group dt {
660
+ display: flex;
661
+ margin-right: 0.5em;
662
+ font-size: 0.875em;
663
+ font-weight: normal;
664
+ }
665
+ dl.tsd-comment-tag-group dd {
666
+ margin: 0;
667
+ }
668
+ code.tsd-tag {
669
+ padding: 0.25em 0.4em;
670
+ border: 0.1em solid var(--color-accent);
671
+ margin-right: 0.25em;
672
+ font-size: 70%;
673
+ }
674
+ h1 code.tsd-tag:first-of-type {
675
+ margin-left: 0.25em;
676
+ }
677
+
678
+ dl.tsd-comment-tag-group dd:before,
679
+ dl.tsd-comment-tag-group dd:after {
680
+ content: " ";
681
+ }
682
+ dl.tsd-comment-tag-group dd pre,
683
+ dl.tsd-comment-tag-group dd:after {
684
+ clear: both;
685
+ }
686
+ dl.tsd-comment-tag-group p {
687
+ margin: 0;
688
+ }
689
+
690
+ .tsd-panel.tsd-comment .lead {
691
+ font-size: 1.1em;
692
+ line-height: 1.333em;
693
+ margin-bottom: 2em;
694
+ }
695
+ .tsd-panel.tsd-comment .lead:last-child {
696
+ margin-bottom: 0;
697
+ }
698
+
699
+ .tsd-filter-visibility h4 {
700
+ font-size: 1rem;
701
+ padding-top: 0.75rem;
702
+ padding-bottom: 0.5rem;
703
+ margin: 0;
704
+ }
705
+ .tsd-filter-item:not(:last-child) {
706
+ margin-bottom: 0.5rem;
707
+ }
708
+ .tsd-filter-input {
709
+ display: flex;
710
+ width: -moz-fit-content;
711
+ width: fit-content;
712
+ align-items: center;
713
+ -webkit-user-select: none;
714
+ -moz-user-select: none;
715
+ -ms-user-select: none;
716
+ user-select: none;
717
+ cursor: pointer;
718
+ }
719
+ .tsd-filter-input input[type="checkbox"] {
720
+ cursor: pointer;
721
+ position: absolute;
722
+ width: 1.5em;
723
+ height: 1.5em;
724
+ opacity: 0;
725
+ }
726
+ .tsd-filter-input input[type="checkbox"]:disabled {
727
+ pointer-events: none;
728
+ }
729
+ .tsd-filter-input svg {
730
+ cursor: pointer;
731
+ width: 1.5em;
732
+ height: 1.5em;
733
+ margin-right: 0.5em;
734
+ border-radius: 0.33em;
735
+ /* Leaving this at full opacity breaks event listeners on Firefox.
736
+ Don't remove unless you know what you're doing. */
737
+ opacity: 0.99;
738
+ }
739
+ .tsd-filter-input input[type="checkbox"]:focus-visible + svg {
740
+ outline: 2px solid var(--color-focus-outline);
741
+ }
742
+ .tsd-checkbox-background {
743
+ fill: var(--color-accent);
744
+ }
745
+ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
746
+ stroke: var(--color-text);
747
+ }
748
+ .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background {
749
+ fill: var(--color-background);
750
+ stroke: var(--color-accent);
751
+ stroke-width: 0.25rem;
752
+ }
753
+ .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark {
754
+ stroke: var(--color-accent);
755
+ }
756
+
757
+ .settings-label {
758
+ font-weight: bold;
759
+ text-transform: uppercase;
760
+ display: inline-block;
761
+ }
762
+
763
+ .tsd-filter-visibility .settings-label {
764
+ margin: 0.75rem 0 0.5rem 0;
765
+ }
766
+
767
+ .tsd-theme-toggle .settings-label {
768
+ margin: 0.75rem 0.75rem 0 0;
769
+ }
770
+
771
+ .tsd-hierarchy h4 label:hover span {
772
+ text-decoration: underline;
773
+ }
774
+
775
+ .tsd-hierarchy {
776
+ list-style: square;
777
+ margin: 0;
778
+ }
779
+ .tsd-hierarchy-target {
780
+ font-weight: bold;
781
+ }
782
+ .tsd-hierarchy-toggle {
783
+ color: var(--color-link);
784
+ cursor: pointer;
785
+ }
786
+
787
+ .tsd-full-hierarchy:not(:last-child) {
788
+ margin-bottom: 1em;
789
+ padding-bottom: 1em;
790
+ border-bottom: 1px solid var(--color-accent);
791
+ }
792
+ .tsd-full-hierarchy,
793
+ .tsd-full-hierarchy ul {
794
+ list-style: none;
795
+ margin: 0;
796
+ padding: 0;
797
+ }
798
+ .tsd-full-hierarchy ul {
799
+ padding-left: 1.5rem;
800
+ }
801
+ .tsd-full-hierarchy a {
802
+ padding: 0.25rem 0 !important;
803
+ font-size: 1rem;
804
+ display: inline-flex;
805
+ align-items: center;
806
+ color: var(--color-text);
807
+ }
808
+ .tsd-full-hierarchy svg[data-dropdown] {
809
+ cursor: pointer;
810
+ }
811
+ .tsd-full-hierarchy svg[data-dropdown="false"] {
812
+ transform: rotate(-90deg);
813
+ }
814
+ .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul {
815
+ display: none;
816
+ }
817
+
818
+ .tsd-panel-group.tsd-index-group {
819
+ margin-bottom: 0;
820
+ }
821
+ .tsd-index-panel .tsd-index-list {
822
+ list-style: none;
823
+ line-height: 1.333em;
824
+ margin: 0;
825
+ padding: 0.25rem 0 0 0;
826
+ overflow: hidden;
827
+ display: grid;
828
+ grid-template-columns: repeat(3, 1fr);
829
+ column-gap: 1rem;
830
+ grid-template-rows: auto;
831
+ }
832
+ @media (max-width: 1024px) {
833
+ .tsd-index-panel .tsd-index-list {
834
+ grid-template-columns: repeat(2, 1fr);
835
+ }
836
+ }
837
+ @media (max-width: 768px) {
838
+ .tsd-index-panel .tsd-index-list {
839
+ grid-template-columns: repeat(1, 1fr);
840
+ }
841
+ }
842
+ .tsd-index-panel .tsd-index-list li {
843
+ -webkit-page-break-inside: avoid;
844
+ -moz-page-break-inside: avoid;
845
+ -ms-page-break-inside: avoid;
846
+ -o-page-break-inside: avoid;
847
+ page-break-inside: avoid;
848
+ }
849
+
850
+ .tsd-flag {
851
+ display: inline-block;
852
+ padding: 0.25em 0.4em;
853
+ border-radius: 4px;
854
+ color: var(--color-comment-tag-text);
855
+ background-color: var(--color-comment-tag);
856
+ text-indent: 0;
857
+ font-size: 75%;
858
+ line-height: 1;
859
+ font-weight: normal;
860
+ }
861
+
862
+ .tsd-anchor {
863
+ position: relative;
864
+ top: -100px;
865
+ }
866
+
867
+ .tsd-member {
868
+ position: relative;
869
+ }
870
+ .tsd-member .tsd-anchor + h3 {
871
+ display: flex;
872
+ align-items: center;
873
+ margin-top: 0;
874
+ margin-bottom: 0;
875
+ border-bottom: none;
876
+ }
877
+
878
+ .tsd-navigation.settings {
879
+ margin: 1rem 0;
880
+ }
881
+ .tsd-navigation > a,
882
+ .tsd-navigation .tsd-accordion-summary {
883
+ width: calc(100% - 0.25rem);
884
+ display: flex;
885
+ align-items: center;
886
+ }
887
+ .tsd-navigation a,
888
+ .tsd-navigation summary > span,
889
+ .tsd-page-navigation a {
890
+ display: flex;
891
+ width: calc(100% - 0.25rem);
892
+ align-items: center;
893
+ padding: 0.25rem;
894
+ color: var(--color-text);
895
+ text-decoration: none;
896
+ box-sizing: border-box;
897
+ }
898
+ .tsd-navigation a.current,
899
+ .tsd-page-navigation a.current {
900
+ background: var(--color-active-menu-item);
901
+ }
902
+ .tsd-navigation a:hover,
903
+ .tsd-page-navigation a:hover {
904
+ text-decoration: underline;
905
+ }
906
+ .tsd-navigation ul,
907
+ .tsd-page-navigation ul {
908
+ margin-top: 0;
909
+ margin-bottom: 0;
910
+ padding: 0;
911
+ list-style: none;
912
+ }
913
+ .tsd-navigation li,
914
+ .tsd-page-navigation li {
915
+ padding: 0;
916
+ max-width: 100%;
917
+ }
918
+ .tsd-navigation .tsd-nav-link {
919
+ display: none;
920
+ }
921
+ .tsd-nested-navigation {
922
+ margin-left: 3rem;
923
+ }
924
+ .tsd-nested-navigation > li > details {
925
+ margin-left: -1.5rem;
926
+ }
927
+ .tsd-small-nested-navigation {
928
+ margin-left: 1.5rem;
929
+ }
930
+ .tsd-small-nested-navigation > li > details {
931
+ margin-left: -1.5rem;
932
+ }
933
+
934
+ .tsd-page-navigation-section {
935
+ margin-left: 10px;
936
+ }
937
+ .tsd-page-navigation-section > summary {
938
+ padding: 0.25rem;
939
+ }
940
+ .tsd-page-navigation-section > div {
941
+ margin-left: 20px;
942
+ }
943
+ .tsd-page-navigation ul {
944
+ padding-left: 1.75rem;
945
+ }
946
+
947
+ #tsd-sidebar-links a {
948
+ margin-top: 0;
949
+ margin-bottom: 0.5rem;
950
+ line-height: 1.25rem;
951
+ }
952
+ #tsd-sidebar-links a:last-of-type {
953
+ margin-bottom: 0;
954
+ }
955
+
956
+ a.tsd-index-link {
957
+ padding: 0.25rem 0 !important;
958
+ font-size: 1rem;
959
+ line-height: 1.25rem;
960
+ display: inline-flex;
961
+ align-items: center;
962
+ color: var(--color-text);
963
+ }
964
+ .tsd-accordion-summary {
965
+ list-style-type: none; /* hide marker on non-safari */
966
+ outline: none; /* broken on safari, so just hide it */
967
+ }
968
+ .tsd-accordion-summary::-webkit-details-marker {
969
+ display: none; /* hide marker on safari */
970
+ }
971
+ .tsd-accordion-summary,
972
+ .tsd-accordion-summary a {
973
+ -moz-user-select: none;
974
+ -webkit-user-select: none;
975
+ -ms-user-select: none;
976
+ user-select: none;
977
+
978
+ cursor: pointer;
979
+ }
980
+ .tsd-accordion-summary a {
981
+ width: calc(100% - 1.5rem);
982
+ }
983
+ .tsd-accordion-summary > * {
984
+ margin-top: 0;
985
+ margin-bottom: 0;
986
+ padding-top: 0;
987
+ padding-bottom: 0;
988
+ }
989
+ .tsd-accordion .tsd-accordion-summary > svg {
990
+ margin-left: 0.25rem;
991
+ vertical-align: text-top;
992
+ }
993
+ /*
994
+ * We need to be careful to target the arrow indicating whether the accordion
995
+ * is open, but not any other SVGs included in the details element.
996
+ */
997
+ .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child,
998
+ .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child,
999
+ .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child,
1000
+ .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child,
1001
+ .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child,
1002
+ .tsd-accordion:not([open]) > .tsd-accordion-summary > h5 > svg:first-child {
1003
+ transform: rotate(-90deg);
1004
+ }
1005
+ .tsd-index-content > :not(:first-child) {
1006
+ margin-top: 0.75rem;
1007
+ }
1008
+ .tsd-index-heading {
1009
+ margin-top: 1.5rem;
1010
+ margin-bottom: 0.75rem;
1011
+ }
1012
+
1013
+ .tsd-no-select {
1014
+ -webkit-user-select: none;
1015
+ -moz-user-select: none;
1016
+ -ms-user-select: none;
1017
+ user-select: none;
1018
+ }
1019
+ .tsd-kind-icon {
1020
+ margin-right: 0.5rem;
1021
+ width: 1.25rem;
1022
+ height: 1.25rem;
1023
+ min-width: 1.25rem;
1024
+ min-height: 1.25rem;
1025
+ }
1026
+ .tsd-signature > .tsd-kind-icon {
1027
+ margin-right: 0.8rem;
1028
+ }
1029
+
1030
+ .tsd-panel {
1031
+ margin-bottom: 2.5rem;
1032
+ }
1033
+ .tsd-panel.tsd-member {
1034
+ margin-bottom: 4rem;
1035
+ }
1036
+ .tsd-panel:empty {
1037
+ display: none;
1038
+ }
1039
+ .tsd-panel > h1,
1040
+ .tsd-panel > h2,
1041
+ .tsd-panel > h3 {
1042
+ margin: 1.5rem -1.5rem 0.75rem -1.5rem;
1043
+ padding: 0 1.5rem 0.75rem 1.5rem;
1044
+ }
1045
+ .tsd-panel > h1.tsd-before-signature,
1046
+ .tsd-panel > h2.tsd-before-signature,
1047
+ .tsd-panel > h3.tsd-before-signature {
1048
+ margin-bottom: 0;
1049
+ border-bottom: none;
1050
+ }
1051
+
1052
+ .tsd-panel-group {
1053
+ margin: 2rem 0;
1054
+ }
1055
+ .tsd-panel-group.tsd-index-group {
1056
+ margin: 2rem 0;
1057
+ }
1058
+ .tsd-panel-group.tsd-index-group details {
1059
+ margin: 2rem 0;
1060
+ }
1061
+ .tsd-panel-group > .tsd-accordion-summary {
1062
+ margin-bottom: 1rem;
1063
+ }
1064
+
1065
+ #tsd-search {
1066
+ transition: background-color 0.2s;
1067
+ }
1068
+ #tsd-search .title {
1069
+ position: relative;
1070
+ z-index: 2;
1071
+ }
1072
+ #tsd-search .field {
1073
+ position: absolute;
1074
+ left: 0;
1075
+ top: 0;
1076
+ right: 2.5rem;
1077
+ height: 100%;
1078
+ }
1079
+ #tsd-search .field input {
1080
+ box-sizing: border-box;
1081
+ position: relative;
1082
+ top: -50px;
1083
+ z-index: 1;
1084
+ width: 100%;
1085
+ padding: 0 10px;
1086
+ opacity: 0;
1087
+ outline: 0;
1088
+ border: 0;
1089
+ background: transparent;
1090
+ color: var(--color-text);
1091
+ }
1092
+ #tsd-search .field label {
1093
+ position: absolute;
1094
+ overflow: hidden;
1095
+ right: -40px;
1096
+ }
1097
+ #tsd-search .field input,
1098
+ #tsd-search .title,
1099
+ #tsd-toolbar-links a {
1100
+ transition: opacity 0.2s;
1101
+ }
1102
+ #tsd-search .results {
1103
+ position: absolute;
1104
+ visibility: hidden;
1105
+ top: 40px;
1106
+ width: 100%;
1107
+ margin: 0;
1108
+ padding: 0;
1109
+ list-style: none;
1110
+ box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
1111
+ }
1112
+ #tsd-search .results li {
1113
+ background-color: var(--color-background);
1114
+ line-height: initial;
1115
+ padding: 4px;
1116
+ }
1117
+ #tsd-search .results li:nth-child(even) {
1118
+ background-color: var(--color-background-secondary);
1119
+ }
1120
+ #tsd-search .results li.state {
1121
+ display: none;
1122
+ }
1123
+ #tsd-search .results li.current:not(.no-results),
1124
+ #tsd-search .results li:hover:not(.no-results) {
1125
+ background-color: var(--color-accent);
1126
+ }
1127
+ #tsd-search .results a {
1128
+ display: flex;
1129
+ align-items: center;
1130
+ padding: 0.25rem;
1131
+ box-sizing: border-box;
1132
+ }
1133
+ #tsd-search .results a:before {
1134
+ top: 10px;
1135
+ }
1136
+ #tsd-search .results span.parent {
1137
+ color: var(--color-text-aside);
1138
+ font-weight: normal;
1139
+ }
1140
+ #tsd-search.has-focus {
1141
+ background-color: var(--color-accent);
1142
+ }
1143
+ #tsd-search.has-focus .field input {
1144
+ top: 0;
1145
+ opacity: 1;
1146
+ }
1147
+ #tsd-search.has-focus .title,
1148
+ #tsd-search.has-focus #tsd-toolbar-links a {
1149
+ z-index: 0;
1150
+ opacity: 0;
1151
+ }
1152
+ #tsd-search.has-focus .results {
1153
+ visibility: visible;
1154
+ }
1155
+ #tsd-search.loading .results li.state.loading {
1156
+ display: block;
1157
+ }
1158
+ #tsd-search.failure .results li.state.failure {
1159
+ display: block;
1160
+ }
1161
+
1162
+ #tsd-toolbar-links {
1163
+ position: absolute;
1164
+ top: 0;
1165
+ right: 2rem;
1166
+ height: 100%;
1167
+ display: flex;
1168
+ align-items: center;
1169
+ justify-content: flex-end;
1170
+ }
1171
+ #tsd-toolbar-links a {
1172
+ margin-left: 1.5rem;
1173
+ }
1174
+ #tsd-toolbar-links a:hover {
1175
+ text-decoration: underline;
1176
+ }
1177
+
1178
+ .tsd-signature {
1179
+ margin: 0 0 1rem 0;
1180
+ padding: 1rem 0.5rem;
1181
+ border: 1px solid var(--color-accent);
1182
+ font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
1183
+ font-size: 14px;
1184
+ overflow-x: auto;
1185
+ }
1186
+
1187
+ .tsd-signature-keyword {
1188
+ color: var(--color-ts-keyword);
1189
+ font-weight: normal;
1190
+ }
1191
+
1192
+ .tsd-signature-symbol {
1193
+ color: var(--color-text-aside);
1194
+ font-weight: normal;
1195
+ }
1196
+
1197
+ .tsd-signature-type {
1198
+ font-style: italic;
1199
+ font-weight: normal;
1200
+ }
1201
+
1202
+ .tsd-signatures {
1203
+ padding: 0;
1204
+ margin: 0 0 1em 0;
1205
+ list-style-type: none;
1206
+ }
1207
+ .tsd-signatures .tsd-signature {
1208
+ margin: 0;
1209
+ border-color: var(--color-accent);
1210
+ border-width: 1px 0;
1211
+ transition: background-color 0.1s;
1212
+ }
1213
+ .tsd-signatures .tsd-index-signature:not(:last-child) {
1214
+ margin-bottom: 1em;
1215
+ }
1216
+ .tsd-signatures .tsd-index-signature .tsd-signature {
1217
+ border-width: 1px;
1218
+ }
1219
+ .tsd-description .tsd-signatures .tsd-signature {
1220
+ border-width: 1px;
1221
+ }
1222
+
1223
+ ul.tsd-parameter-list,
1224
+ ul.tsd-type-parameter-list {
1225
+ list-style: square;
1226
+ margin: 0;
1227
+ padding-left: 20px;
1228
+ }
1229
+ ul.tsd-parameter-list > li.tsd-parameter-signature,
1230
+ ul.tsd-type-parameter-list > li.tsd-parameter-signature {
1231
+ list-style: none;
1232
+ margin-left: -20px;
1233
+ }
1234
+ ul.tsd-parameter-list h5,
1235
+ ul.tsd-type-parameter-list h5 {
1236
+ font-size: 16px;
1237
+ margin: 1em 0 0.5em 0;
1238
+ }
1239
+ .tsd-sources {
1240
+ margin-top: 1rem;
1241
+ font-size: 0.875em;
1242
+ }
1243
+ .tsd-sources a {
1244
+ color: var(--color-text-aside);
1245
+ text-decoration: underline;
1246
+ }
1247
+ .tsd-sources ul {
1248
+ list-style: none;
1249
+ padding: 0;
1250
+ }
1251
+
1252
+ .tsd-page-toolbar {
1253
+ position: sticky;
1254
+ z-index: 1;
1255
+ top: 0;
1256
+ left: 0;
1257
+ width: 100%;
1258
+ color: var(--color-text);
1259
+ background: var(--color-background-secondary);
1260
+ border-bottom: 1px var(--color-accent) solid;
1261
+ transition: transform 0.3s ease-in-out;
1262
+ }
1263
+ .tsd-page-toolbar a {
1264
+ color: var(--color-text);
1265
+ text-decoration: none;
1266
+ }
1267
+ .tsd-page-toolbar a.title {
1268
+ font-weight: bold;
1269
+ }
1270
+ .tsd-page-toolbar a.title:hover {
1271
+ text-decoration: underline;
1272
+ }
1273
+ .tsd-page-toolbar .tsd-toolbar-contents {
1274
+ display: flex;
1275
+ justify-content: space-between;
1276
+ height: 2.5rem;
1277
+ margin: 0 auto;
1278
+ }
1279
+ .tsd-page-toolbar .table-cell {
1280
+ position: relative;
1281
+ white-space: nowrap;
1282
+ line-height: 40px;
1283
+ }
1284
+ .tsd-page-toolbar .table-cell:first-child {
1285
+ width: 100%;
1286
+ }
1287
+ .tsd-page-toolbar .tsd-toolbar-icon {
1288
+ box-sizing: border-box;
1289
+ line-height: 0;
1290
+ padding: 12px 0;
1291
+ }
1292
+
1293
+ .tsd-widget {
1294
+ display: inline-block;
1295
+ overflow: hidden;
1296
+ opacity: 0.8;
1297
+ height: 40px;
1298
+ transition:
1299
+ opacity 0.1s,
1300
+ background-color 0.2s;
1301
+ vertical-align: bottom;
1302
+ cursor: pointer;
1303
+ }
1304
+ .tsd-widget:hover {
1305
+ opacity: 0.9;
1306
+ }
1307
+ .tsd-widget.active {
1308
+ opacity: 1;
1309
+ background-color: var(--color-accent);
1310
+ }
1311
+ .tsd-widget.no-caption {
1312
+ width: 40px;
1313
+ }
1314
+ .tsd-widget.no-caption:before {
1315
+ margin: 0;
1316
+ }
1317
+
1318
+ .tsd-widget.options,
1319
+ .tsd-widget.menu {
1320
+ display: none;
1321
+ }
1322
+ input[type="checkbox"] + .tsd-widget:before {
1323
+ background-position: -120px 0;
1324
+ }
1325
+ input[type="checkbox"]:checked + .tsd-widget:before {
1326
+ background-position: -160px 0;
1327
+ }
1328
+
1329
+ img {
1330
+ max-width: 100%;
1331
+ }
1332
+
1333
+ .tsd-member-summary-name {
1334
+ display: inline-flex;
1335
+ align-items: center;
1336
+ padding: 0.25rem;
1337
+ text-decoration: none;
1338
+ }
1339
+
1340
+ .tsd-anchor-icon {
1341
+ display: inline-flex;
1342
+ align-items: center;
1343
+ margin-left: 0.5rem;
1344
+ color: var(--color-text);
1345
+ }
1346
+
1347
+ .tsd-anchor-icon svg {
1348
+ width: 1em;
1349
+ height: 1em;
1350
+ visibility: hidden;
1351
+ }
1352
+
1353
+ .tsd-member-summary-name:hover > .tsd-anchor-icon svg,
1354
+ .tsd-anchor-link:hover > .tsd-anchor-icon svg {
1355
+ visibility: visible;
1356
+ }
1357
+
1358
+ .deprecated {
1359
+ text-decoration: line-through !important;
1360
+ }
1361
+
1362
+ .warning {
1363
+ padding: 1rem;
1364
+ color: var(--color-warning-text);
1365
+ background: var(--color-background-warning);
1366
+ }
1367
+
1368
+ .tsd-kind-project {
1369
+ color: var(--color-ts-project);
1370
+ }
1371
+ .tsd-kind-module {
1372
+ color: var(--color-ts-module);
1373
+ }
1374
+ .tsd-kind-namespace {
1375
+ color: var(--color-ts-namespace);
1376
+ }
1377
+ .tsd-kind-enum {
1378
+ color: var(--color-ts-enum);
1379
+ }
1380
+ .tsd-kind-enum-member {
1381
+ color: var(--color-ts-enum-member);
1382
+ }
1383
+ .tsd-kind-variable {
1384
+ color: var(--color-ts-variable);
1385
+ }
1386
+ .tsd-kind-function {
1387
+ color: var(--color-ts-function);
1388
+ }
1389
+ .tsd-kind-class {
1390
+ color: var(--color-ts-class);
1391
+ }
1392
+ .tsd-kind-interface {
1393
+ color: var(--color-ts-interface);
1394
+ }
1395
+ .tsd-kind-constructor {
1396
+ color: var(--color-ts-constructor);
1397
+ }
1398
+ .tsd-kind-property {
1399
+ color: var(--color-ts-property);
1400
+ }
1401
+ .tsd-kind-method {
1402
+ color: var(--color-ts-method);
1403
+ }
1404
+ .tsd-kind-reference {
1405
+ color: var(--color-ts-reference);
1406
+ }
1407
+ .tsd-kind-call-signature {
1408
+ color: var(--color-ts-call-signature);
1409
+ }
1410
+ .tsd-kind-index-signature {
1411
+ color: var(--color-ts-index-signature);
1412
+ }
1413
+ .tsd-kind-constructor-signature {
1414
+ color: var(--color-ts-constructor-signature);
1415
+ }
1416
+ .tsd-kind-parameter {
1417
+ color: var(--color-ts-parameter);
1418
+ }
1419
+ .tsd-kind-type-parameter {
1420
+ color: var(--color-ts-type-parameter);
1421
+ }
1422
+ .tsd-kind-accessor {
1423
+ color: var(--color-ts-accessor);
1424
+ }
1425
+ .tsd-kind-get-signature {
1426
+ color: var(--color-ts-get-signature);
1427
+ }
1428
+ .tsd-kind-set-signature {
1429
+ color: var(--color-ts-set-signature);
1430
+ }
1431
+ .tsd-kind-type-alias {
1432
+ color: var(--color-ts-type-alias);
1433
+ }
1434
+
1435
+ /* if we have a kind icon, don't color the text by kind */
1436
+ .tsd-kind-icon ~ span {
1437
+ color: var(--color-text);
1438
+ }
1439
+
1440
+ * {
1441
+ scrollbar-width: thin;
1442
+ scrollbar-color: var(--color-accent) var(--color-icon-background);
1443
+ }
1444
+
1445
+ *::-webkit-scrollbar {
1446
+ width: 0.75rem;
1447
+ }
1448
+
1449
+ *::-webkit-scrollbar-track {
1450
+ background: var(--color-icon-background);
1451
+ }
1452
+
1453
+ *::-webkit-scrollbar-thumb {
1454
+ background-color: var(--color-accent);
1455
+ border-radius: 999rem;
1456
+ border: 0.25rem solid var(--color-icon-background);
1457
+ }
1458
+
1459
+ /* mobile */
1460
+ @media (max-width: 769px) {
1461
+ .tsd-widget.options,
1462
+ .tsd-widget.menu {
1463
+ display: inline-block;
1464
+ }
1465
+
1466
+ .container-main {
1467
+ display: flex;
1468
+ }
1469
+ html .col-content {
1470
+ float: none;
1471
+ max-width: 100%;
1472
+ width: 100%;
1473
+ }
1474
+ html .col-sidebar {
1475
+ position: fixed !important;
1476
+ overflow-y: auto;
1477
+ -webkit-overflow-scrolling: touch;
1478
+ z-index: 1024;
1479
+ top: 0 !important;
1480
+ bottom: 0 !important;
1481
+ left: auto !important;
1482
+ right: 0 !important;
1483
+ padding: 1.5rem 1.5rem 0 0;
1484
+ width: 75vw;
1485
+ visibility: hidden;
1486
+ background-color: var(--color-background);
1487
+ transform: translate(100%, 0);
1488
+ }
1489
+ html .col-sidebar > *:last-child {
1490
+ padding-bottom: 20px;
1491
+ }
1492
+ html .overlay {
1493
+ content: "";
1494
+ display: block;
1495
+ position: fixed;
1496
+ z-index: 1023;
1497
+ top: 0;
1498
+ left: 0;
1499
+ right: 0;
1500
+ bottom: 0;
1501
+ background-color: rgba(0, 0, 0, 0.75);
1502
+ visibility: hidden;
1503
+ }
1504
+
1505
+ .to-has-menu .overlay {
1506
+ animation: fade-in 0.4s;
1507
+ }
1508
+
1509
+ .to-has-menu .col-sidebar {
1510
+ animation: pop-in-from-right 0.4s;
1511
+ }
1512
+
1513
+ .from-has-menu .overlay {
1514
+ animation: fade-out 0.4s;
1515
+ }
1516
+
1517
+ .from-has-menu .col-sidebar {
1518
+ animation: pop-out-to-right 0.4s;
1519
+ }
1520
+
1521
+ .has-menu body {
1522
+ overflow: hidden;
1523
+ }
1524
+ .has-menu .overlay {
1525
+ visibility: visible;
1526
+ }
1527
+ .has-menu .col-sidebar {
1528
+ visibility: visible;
1529
+ transform: translate(0, 0);
1530
+ display: flex;
1531
+ flex-direction: column;
1532
+ gap: 1.5rem;
1533
+ max-height: 100vh;
1534
+ padding: 1rem 2rem;
1535
+ }
1536
+ .has-menu .tsd-navigation {
1537
+ max-height: 100%;
1538
+ }
1539
+ #tsd-toolbar-links {
1540
+ display: none;
1541
+ }
1542
+ .tsd-navigation .tsd-nav-link {
1543
+ display: flex;
1544
+ }
1545
+ }
1546
+
1547
+ /* one sidebar */
1548
+ @media (min-width: 770px) {
1549
+ .container-main {
1550
+ display: grid;
1551
+ grid-template-columns: minmax(0, 1fr) minmax(0, 2fr);
1552
+ grid-template-areas: "sidebar content";
1553
+ margin: 2rem auto;
1554
+ }
1555
+
1556
+ .col-sidebar {
1557
+ grid-area: sidebar;
1558
+ }
1559
+ .col-content {
1560
+ grid-area: content;
1561
+ padding: 0 1rem;
1562
+ }
1563
+ }
1564
+ @media (min-width: 770px) and (max-width: 1399px) {
1565
+ .col-sidebar {
1566
+ max-height: calc(100vh - 2rem - 42px);
1567
+ overflow: auto;
1568
+ position: sticky;
1569
+ top: 42px;
1570
+ padding-top: 1rem;
1571
+ }
1572
+ .site-menu {
1573
+ margin-top: 1rem;
1574
+ }
1575
+ }
1576
+
1577
+ /* two sidebars */
1578
+ @media (min-width: 1200px) {
1579
+ .container-main {
1580
+ grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(
1581
+ 0,
1582
+ 20rem
1583
+ );
1584
+ grid-template-areas: "sidebar content toc";
1585
+ }
1586
+
1587
+ .col-sidebar {
1588
+ display: contents;
1589
+ }
1590
+
1591
+ .page-menu {
1592
+ grid-area: toc;
1593
+ padding-left: 1rem;
1594
+ }
1595
+ .site-menu {
1596
+ grid-area: sidebar;
1597
+ }
1598
+
1599
+ .site-menu {
1600
+ margin-top: 1rem;
1601
+ }
1602
+
1603
+ .page-menu,
1604
+ .site-menu {
1605
+ max-height: calc(100vh - 2rem - 42px);
1606
+ overflow: auto;
1607
+ position: sticky;
1608
+ top: 42px;
1609
+ }
1610
+ }
1611
+ }
classes/types.react-declarative.ArraySet.html ADDED
The diff for this file is too large to render. See raw diff
 
classes/types.react-declarative.AutoSizer.html ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AutoSizer | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.AutoSizer.html">AutoSizer</a></li></ul><h1>Class AutoSizer&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A component that automatically resizes its children based on its parent element's size.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">unknown</span> = <span class="tsd-signature-type">object</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1370"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.AutoSizer">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../variables/types.react-declarative.dayjs.html" class="tsd-signature-type tsd-kind-variable">dayjs</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.IAutoSizerProps.html" class="tsd-signature-type tsd-kind-interface">IAutoSizerProps</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.AutoSizer.html#constructorautosizert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">AutoSizer</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25063">types.d.ts:25063</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.AutoSizer.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.AutoSizer.html#_autosizer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_auto<wbr/>Sizer?</span></a>
4
+ <a href="types.react-declarative.AutoSizer.html#_detectelementresize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_detect<wbr/>Element<wbr/>Resize?</span></a>
5
+ <a href="types.react-declarative.AutoSizer.html#_parentnode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_parent<wbr/>Node?</span></a>
6
+ <a href="types.react-declarative.AutoSizer.html#_setref" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_set<wbr/>Ref</span></a>
7
+ <a href="types.react-declarative.AutoSizer.html#defaultprops" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props</span></a>
8
+ <a href="types.react-declarative.AutoSizer.html#lastheightrequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Height<wbr/>Request</span></a>
9
+ <a href="types.react-declarative.AutoSizer.html#lastwidthrequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Width<wbr/>Request</span></a>
10
+ <a href="types.react-declarative.AutoSizer.html#state" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a>
11
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="types.react-declarative.AutoSizer.html#componentdidmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a>
12
+ <a href="types.react-declarative.AutoSizer.html#componentwillunmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a>
13
+ <a href="types.react-declarative.AutoSizer.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a>
14
+ <a href="types.react-declarative.AutoSizer.html#shouldcomponentupdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Component<wbr/>Update</span></a>
15
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorautosizer" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">AutoSizer</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.AutoSizer.html#constructorautosizert">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.AutoSizer.html" class="tsd-signature-type tsd-kind-class">AutoSizer</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.AutoSizer.html#constructorautosizert">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructorautosizer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorautosizert" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">unknown</span> = <span class="tsd-signature-type">object</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.AutoSizer.html" class="tsd-signature-type tsd-kind-class">AutoSizer</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.AutoSizer.html#constructorautosizert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from React.Component&lt;
16
+ IAutoSizerProps&lt;T&gt;,
17
+ State
18
+ &gt;.constructor</p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="_autosizer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>_auto<wbr/>Sizer</span><a href="#_autosizer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_autoSizer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25091">types.d.ts:25091</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="_detectelementresize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>_detect<wbr/>Element<wbr/>Resize</span><a href="#_detectelementresize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_detectElementResize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DetectElementResize</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25092">types.d.ts:25092</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="_parentnode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>_parent<wbr/>Node</span><a href="#_parentnode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_parentNode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HTMLElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25090">types.d.ts:25090</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="_setref" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>_set<wbr/>Ref</span><a href="#_setref" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_setRef</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">autoSizer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Sets the reference to the autoSizer element.</p>
19
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">autoSizer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">autoSizer</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLElement</span></span><div class="tsd-comment tsd-typography"><p>The autoSizer element or null.</p>
20
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25137">types.d.ts:25137</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="defaultprops" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>default<wbr/>Props</span><a href="#defaultprops" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">defaultProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.IAutoSizerProps.html" class="tsd-signature-type tsd-kind-interface">IAutoSizerProps</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Default properties for the AutoSizer component.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25072">types.d.ts:25072</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lastheightrequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last<wbr/>Height<wbr/>Request</span><a href="#lastheightrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lastHeightRequest</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">h</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25073">types.d.ts:25073</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lastwidthrequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last<wbr/>Width<wbr/>Request</span><a href="#lastwidthrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lastWidthRequest</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">w</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25074">types.d.ts:25074</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">childHeight</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">childWidth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Represents the state of a component.</p>
22
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25084">types.d.ts:25084</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="componentdidmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Mount</span><a href="#componentdidmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="componentdidmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentDidMount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentdidmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Executes after the component has been mounted to the DOM.
23
+ It sets up the element for resizing and calls the resize event handler.</p>
24
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25110">types.d.ts:25110</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="componentwillunmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Will<wbr/>Unmount</span><a href="#componentwillunmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="componentwillunmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillUnmount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentwillunmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>This method is invoked immediately before a component is unmounted and destroyed.</p>
25
+ <p>It removes the resize listener if it exists and the parent node is defined.</p>
26
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25116">types.d.ts:25116</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="render-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">render</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Element</span><a href="#render-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Renders a container div with specified child parameters and styles.</p>
27
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><ul>
28
+ <li>The rendered container div element.</li>
29
+ </ul>
30
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25122">types.d.ts:25122</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="shouldcomponentupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>should<wbr/>Component<wbr/>Update</span><a href="#shouldcomponentupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="shouldcomponentupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">shouldComponentUpdate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components.IAutoSizerProps.html" class="tsd-signature-type tsd-kind-interface">IAutoSizerProps</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.AutoSizer.html#constructorautosizert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">nextState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#shouldcomponentupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines whether the component should update based on the changes in the nextProps and nextState.</p>
31
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <a href="../interfaces/types.react-declarative_components.IAutoSizerProps.html" class="tsd-signature-type tsd-kind-interface">IAutoSizerProps</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.AutoSizer.html#constructorautosizert">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The next props that will be received by the component.</p>
32
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">State</span></span><div class="tsd-comment tsd-typography"><p>The next state that will be set in the component.</p>
33
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><ul>
34
+ <li>Returns true if the component should update, otherwise false.</li>
35
+ </ul>
36
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L25100">types.d.ts:25100</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_autosizer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_auto<wbr/>Sizer</span></a><a href="#_detectelementresize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_detect<wbr/>Element<wbr/>Resize</span></a><a href="#_parentnode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_parent<wbr/>Node</span></a><a href="#_setref" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_set<wbr/>Ref</span></a><a href="#defaultprops" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Props</span></a><a href="#lastheightrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Height<wbr/>Request</span></a><a href="#lastwidthrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Width<wbr/>Request</span></a><a href="#state" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#componentdidmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a><a href="#componentwillunmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a><a href="#shouldcomponentupdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Component<wbr/>Update</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.BehaviorSubject.html ADDED
The diff for this file is too large to render. See raw diff
 
classes/types.react-declarative.ChatController.html ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChatController | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.ChatController.html">ChatController</a></li></ul><h1>Class ChatController</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing a Chat Controller.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27483">types.d.ts:27483</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.ChatController.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="types.react-declarative.ChatController.html#addmessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Message</span></a>
4
+ <a href="types.react-declarative.ChatController.html#addonactionchanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>On<wbr/>Action<wbr/>Changed</span></a>
5
+ <a href="types.react-declarative.ChatController.html#addonmessageschanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>On<wbr/>Messages<wbr/>Changed</span></a>
6
+ <a href="types.react-declarative.ChatController.html#cancelactionrequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Action<wbr/>Request</span></a>
7
+ <a href="types.react-declarative.ChatController.html#clearmessages" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Messages</span></a>
8
+ <a href="types.react-declarative.ChatController.html#getactionrequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Request</span></a>
9
+ <a href="types.react-declarative.ChatController.html#getactionresponses" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Responses</span></a>
10
+ <a href="types.react-declarative.ChatController.html#getmessages" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Messages</span></a>
11
+ <a href="types.react-declarative.ChatController.html#getoption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option</span></a>
12
+ <a href="types.react-declarative.ChatController.html#removemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Message</span></a>
13
+ <a href="types.react-declarative.ChatController.html#removeonactionchanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>On<wbr/>Action<wbr/>Changed</span></a>
14
+ <a href="types.react-declarative.ChatController.html#removeonmessageschanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>On<wbr/>Messages<wbr/>Changed</span></a>
15
+ <a href="types.react-declarative.ChatController.html#setactionrequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Action<wbr/>Request</span></a>
16
+ <a href="types.react-declarative.ChatController.html#setactionresponse" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Action<wbr/>Response</span></a>
17
+ <a href="types.react-declarative.ChatController.html#setmessages" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Messages</span></a>
18
+ <a href="types.react-declarative.ChatController.html#updatemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Message</span></a>
19
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorchatcontroller" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ChatController</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_ChatOption.ChatOption.html" class="tsd-signature-type tsd-kind-interface">ChatOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.ChatController.html" class="tsd-signature-type tsd-kind-class">ChatController</a><a href="#constructorchatcontroller" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructs an instance of ChatController.</p>
20
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">option</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_ChatOption.ChatOption.html" class="tsd-signature-type tsd-kind-interface">ChatOption</a></span><div class="tsd-comment tsd-typography"><p>The chat options.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.ChatController.html" class="tsd-signature-type tsd-kind-class">ChatController</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27488">types.d.ts:27488</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="addmessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Message</span><a href="#addmessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="addmessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#addmessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a message to the chat.</p>
22
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The message to add.</p>
23
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise resolving to the index of the added message.</p>
24
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27494">types.d.ts:27494</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="addonactionchanged" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>On<wbr/>Action<wbr/>Changed</span><a href="#addonactionchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="addonactionchanged-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addOnActionChanged</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_OnActionChanged.OnActionChanged.html" class="tsd-signature-type tsd-kind-interface">OnActionChanged</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addonactionchanged-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an event handler for action changed.</p>
25
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_OnActionChanged.OnActionChanged.html" class="tsd-signature-type tsd-kind-interface">OnActionChanged</a></span><div class="tsd-comment tsd-typography"><p>The event handler to add.</p>
26
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27568">types.d.ts:27568</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="addonmessageschanged" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>On<wbr/>Messages<wbr/>Changed</span><a href="#addonmessageschanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="addonmessageschanged-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addOnMessagesChanged</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_OnMessagesChanged.OnMessagesChanged.html" class="tsd-signature-type tsd-kind-interface">OnMessagesChanged</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addonmessageschanged-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an event handler for messages changed.</p>
27
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_OnMessagesChanged.OnMessagesChanged.html" class="tsd-signature-type tsd-kind-interface">OnMessagesChanged</a></span><div class="tsd-comment tsd-typography"><p>The event handler to add.</p>
28
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27524">types.d.ts:27524</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="cancelactionrequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cancel<wbr/>Action<wbr/>Request</span><a href="#cancelactionrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="cancelactionrequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">cancelActionRequest</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#cancelactionrequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Cancels the current action request.</p>
29
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27543">types.d.ts:27543</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="clearmessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Messages</span><a href="#clearmessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="clearmessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clearMessages</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearmessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears all messages from the chat.</p>
30
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27519">types.d.ts:27519</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getactionrequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Action<wbr/>Request</span><a href="#getactionrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getactionrequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getActionRequest</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.react-declarative_components.ActionRequest.html" class="tsd-signature-type tsd-kind-interface">ActionRequest</a><a href="#getactionrequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the current action request.</p>
31
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.react-declarative_components.ActionRequest.html" class="tsd-signature-type tsd-kind-interface">ActionRequest</a></h4><p>The current action request.</p>
32
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27548">types.d.ts:27548</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getactionresponses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Action<wbr/>Responses</span><a href="#getactionresponses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getactionresponses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getActionResponses</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_ActionResponse.ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a><span class="tsd-signature-symbol">[]</span><a href="#getactionresponses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets all action responses.</p>
33
+ </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/types.react-declarative_components_ChatView_model_ActionResponse.ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a><span class="tsd-signature-symbol">[]</span></h4><p>An array of action responses.</p>
34
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27563">types.d.ts:27563</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getmessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Messages</span><a href="#getmessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getmessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getMessages</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><a href="#getmessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets all messages in the chat.</p>
35
+ </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h4><p>An array of messages.</p>
36
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27510">types.d.ts:27510</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getoption" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Option</span><a href="#getoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getoption-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getOption</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_ChatOption.ChatOption.html" class="tsd-signature-type tsd-kind-interface">ChatOption</a><a href="#getoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the chat options.</p>
37
+ </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/types.react-declarative_components_ChatView_model_ChatOption.ChatOption.html" class="tsd-signature-type tsd-kind-interface">ChatOption</a></h4><p>The chat options.</p>
38
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27578">types.d.ts:27578</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="removemessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Message</span><a href="#removemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="removemessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">removeMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removemessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a message from the chat.</p>
39
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the message to remove.</p>
40
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27505">types.d.ts:27505</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="removeonactionchanged" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>On<wbr/>Action<wbr/>Changed</span><a href="#removeonactionchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="removeonactionchanged-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">removeOnActionChanged</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_OnActionChanged.OnActionChanged.html" class="tsd-signature-type tsd-kind-interface">OnActionChanged</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removeonactionchanged-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes an event handler for action changed.</p>
41
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_OnActionChanged.OnActionChanged.html" class="tsd-signature-type tsd-kind-interface">OnActionChanged</a></span><div class="tsd-comment tsd-typography"><p>The event handler to remove.</p>
42
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27573">types.d.ts:27573</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="removeonmessageschanged" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>On<wbr/>Messages<wbr/>Changed</span><a href="#removeonmessageschanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="removeonmessageschanged-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">removeOnMessagesChanged</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_OnMessagesChanged.OnMessagesChanged.html" class="tsd-signature-type tsd-kind-interface">OnMessagesChanged</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removeonmessageschanged-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes an event handler for messages changed.</p>
43
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_OnMessagesChanged.OnMessagesChanged.html" class="tsd-signature-type tsd-kind-interface">OnMessagesChanged</a></span><div class="tsd-comment tsd-typography"><p>The event handler to remove.</p>
44
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27529">types.d.ts:27529</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setactionrequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Action<wbr/>Request</span><a href="#setactionrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setactionrequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setActionRequest</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.ChatController.html#setactionrequestt">T</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/types.react-declarative_components.ActionRequest.html" class="tsd-signature-type tsd-kind-interface">ActionRequest</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.ChatController.html#setactionrequestt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">onResponse</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_OnActionResponsed.OnActionResponsed.html" class="tsd-signature-type tsd-kind-interface">OnActionResponsed</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components_ChatView_model_ActionResponse.ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#setactionrequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the action request and its response handlers.</p>
45
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="setactionrequestt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_components.ActionRequest.html" class="tsd-signature-type tsd-kind-interface">ActionRequest</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.ChatController.html#setactionrequestt">T</a></span><div class="tsd-comment tsd-typography"><p>The action request.</p>
46
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">onResponse</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_OnActionResponsed.OnActionResponsed.html" class="tsd-signature-type tsd-kind-interface">OnActionResponsed</a></span><div class="tsd-comment tsd-typography"><p>The response handler.</p>
47
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components_ChatView_model_ActionResponse.ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise resolving to the action response.</p>
48
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27536">types.d.ts:27536</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setactionresponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Action<wbr/>Response</span><a href="#setactionresponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setactionresponse-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setActionResponse</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components.ActionRequest.html" class="tsd-signature-type tsd-kind-interface">ActionRequest</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_ActionResponse.ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#setactionresponse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the action response and triggers related actions.</p>
49
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/types.react-declarative_components.ActionRequest.html" class="tsd-signature-type tsd-kind-interface">ActionRequest</a></span><div class="tsd-comment tsd-typography"><p>The action request.</p>
50
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">response</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_ActionResponse.ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a></span><div class="tsd-comment tsd-typography"><p>The action response.</p>
51
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise resolving when the action response is processed.</p>
52
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27555">types.d.ts:27555</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setmessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Messages</span><a href="#setmessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setmessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setMessages</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">messages</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setmessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the messages in the chat.</p>
53
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">messages</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The messages to set.</p>
54
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27515">types.d.ts:27515</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="updatemessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Message</span><a href="#updatemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="updatemessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatemessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates a message in the chat.</p>
55
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the message to update.</p>
56
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/types.react-declarative_components_ChatView_model_Message.Message.html" class="tsd-signature-type tsd-kind-interface">Message</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The updated message.</p>
57
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27500">types.d.ts:27500</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addmessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Message</span></a><a href="#addonactionchanged" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>On<wbr/>Action<wbr/>Changed</span></a><a href="#addonmessageschanged" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>On<wbr/>Messages<wbr/>Changed</span></a><a href="#cancelactionrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Action<wbr/>Request</span></a><a href="#clearmessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Messages</span></a><a href="#getactionrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Request</span></a><a href="#getactionresponses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Responses</span></a><a href="#getmessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Messages</span></a><a href="#getoption" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option</span></a><a href="#removemessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Message</span></a><a href="#removeonactionchanged" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>On<wbr/>Action<wbr/>Changed</span></a><a href="#removeonmessageschanged" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>On<wbr/>Messages<wbr/>Changed</span></a><a href="#setactionrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Action<wbr/>Request</span></a><a href="#setactionresponse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Action<wbr/>Response</span></a><a href="#setmessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Messages</span></a><a href="#updatemessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Message</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.Collection.html ADDED
The diff for this file is too large to render. See raw diff
 
classes/types.react-declarative.Entity.html ADDED
@@ -0,0 +1,67 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Entity | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.Entity.html">Entity</a></li></ul><h1>Class Entity&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="tsd-tag-description"><h4 class="tsd-anchor-link"><a id="description" class="tsd-anchor"></a>Description<a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>MVVM Object wrapper. Emmits change after setData</p>
2
+ </div></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="4571"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.Entity">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Entity</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html" class="tsd-signature-type tsd-kind-interface">IEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10106">types.d.ts:10106</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.Entity.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.Entity.html#_data" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_data</span></a>
4
+ <a href="types.react-declarative.Entity.html#_debounce" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_debounce</span></a>
5
+ <a href="types.react-declarative.Entity.html#_dropchanges" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_drop<wbr/>Changes</span></a>
6
+ <a href="types.react-declarative.Entity.html#_prevdata" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_prev<wbr/>Data</span></a>
7
+ <a href="types.react-declarative.Entity.html#emit" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a>
8
+ <a href="types.react-declarative.Entity.html#getlisteners" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Listeners</span></a>
9
+ <a href="types.react-declarative.Entity.html#handlechange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Change</span></a>
10
+ <a href="types.react-declarative.Entity.html#handledropchanges" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Drop<wbr/>Changes</span></a>
11
+ <a href="types.react-declarative.Entity.html#once" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a>
12
+ <a href="types.react-declarative.Entity.html#refresh" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a>
13
+ <a href="types.react-declarative.Entity.html#setdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a>
14
+ <a href="types.react-declarative.Entity.html#subscribe" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe</span></a>
15
+ <a href="types.react-declarative.Entity.html#toobject" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a>
16
+ <a href="types.react-declarative.Entity.html#unsubscribe" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a>
17
+ <a href="types.react-declarative.Entity.html#unsubscribeall" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>All</span></a>
18
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative.Entity.html#data" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a>
19
+ <a href="types.react-declarative.Entity.html#haslisteners" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Listeners</span></a>
20
+ <a href="types.react-declarative.Entity.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a>
21
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorentity" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Entity</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">_data</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_debounce</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_prevData</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructorentity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorentityt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_data</span>: <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_debounce</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_prevData</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Overrides <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10116">types.d.ts:10116</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="_data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_data</span><a href="#_data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_data</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#_data">_data</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10547">types.d.ts:10547</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="_debounce" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_debounce</span><a href="#_debounce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_debounce</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#_debounce">_debounce</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10544">types.d.ts:10544</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="_dropchanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_drop<wbr/>Changes</span><a href="#_dropchanges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_dropChanges</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#_dropchanges">_dropChanges</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10546">types.d.ts:10546</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="_prevdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_prev<wbr/>Data</span><a href="#_prevdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_prevData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#_prevdata">_prevData</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10545">types.d.ts:10545</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Emits the given event with the specified arguments.</p>
22
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The name of the event to emit.</p>
23
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The arguments to pass to the event listeners.</p>
24
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
25
+ <li>A promise that resolves when all event listeners have completed.</li>
26
+ </ul>
27
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#emit">emit</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8760">types.d.ts:8760</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getlisteners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Listeners</span><a href="#getlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getListeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the listeners associated with the given event key.</p>
28
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The event key to retrieve the listeners for.</p>
29
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4><p>An array of listeners associated with the given event key.</p>
30
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#getlisteners">getListeners</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8722">types.d.ts:8722</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="handlechange" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>handle<wbr/>Change</span><a href="#handlechange" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">handleChange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">change</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Handles change events.</p>
31
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">change</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">change</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>The change event handler function.</p>
32
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h4><ul>
33
+ <li>The function to unregister the change event.</li>
34
+ </ul>
35
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#handlechange">handleChange</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10137">types.d.ts:10137</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="handledropchanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>handle<wbr/>Drop<wbr/>Changes</span><a href="#handledropchanges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">handleDropChanges</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Handles the changes when an item is dropped.</p>
36
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>handleDropChanges</p>
37
+ </div><div class="tsd-tag-memberof"><h4 class="tsd-anchor-link"><a id="memberof" class="tsd-anchor"></a>Memberof<a href="#memberof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ClassName</p>
38
+ </div></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#handledropchanges">handleDropChanges</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10585">types.d.ts:10585</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">once</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Subscribes a callback function to the given event name. The callback function will be triggered only once when the event is emitted.</p>
39
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The name of the event to subscribe to.</p>
40
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to be executed when the event is emitted.</p>
41
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h4><ul>
42
+ <li>A function that can be called to unsubscribe the callback function from the event.</li>
43
+ </ul>
44
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#once">once</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8752">types.d.ts:8752</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="refresh" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh</span><a href="#refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">refresh</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>A function that triggers a refresh event.</p>
45
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-1" class="tsd-anchor"></a>Function<a href="#function-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-memberOf"><h4 class="tsd-anchor-link"><a id="member-of" class="tsd-anchor"></a>Member Of<a href="#member-of" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>global</p>
46
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#refresh">refresh</a></p><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#refresh">refresh</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10593">types.d.ts:10593</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Data</span><a href="#setdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Sets the data for the given variable.</p>
47
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to be set.
48
+ This can either be a partial object of type T or a function that takes the previous data
49
+ of type T and returns a partial object of type T.</p>
50
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#setdata">setData</a></p><p>Overrides <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#setdata">setData</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10130">types.d.ts:10130</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">subscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Subscribes a callback function to the specified event name.</p>
51
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The key of the event.</p>
52
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to be executed when the event is triggered.</p>
53
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#subscribe">subscribe</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8730">types.d.ts:8730</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toobject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a></div><div class="tsd-comment tsd-typography"><p>Converts the object into a plain JavaScript object.</p>
54
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Entity.html#constructorentityt">T</a></h4><ul>
55
+ <li>The plain JavaScript object representation.</li>
56
+ </ul>
57
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-2" class="tsd-anchor"></a>Function<a href="#function-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#toobject">toObject</a></p><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#toobject">toObject</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10600">types.d.ts:10600</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unsubscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe</span><a href="#unsubscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsubscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Removes a callback function from the list of event listeners for the specified event.</p>
58
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The key of the event to unsubscribe from.</p>
59
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to remove from the event listeners.</p>
60
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#unsubscribe">unsubscribe</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8738">types.d.ts:8738</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unsubscribeall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>All</span><a href="#unsubscribeall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsubscribeAll</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears all event handlers registered for the current object.</p>
61
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-3" class="tsd-anchor"></a>Function<a href="#function-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.Model.html">Model</a>.<a href="types.react-declarative.Model.html#unsubscribeall">unsubscribeAll</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8744">types.d.ts:8744</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature" id="data-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">data</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the value of the data property.</p>
62
+ </div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></h4><p>The frozen data.</p>
63
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#data">data</a></p><p>Inherited from Model.data</p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10553">types.d.ts:10553</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="haslisteners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Listeners</span><a href="#haslisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature" id="haslisteners-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hasListeners</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if the object has any listeners attached to it.</p>
64
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the object has listeners, false otherwise.</p>
65
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Model.hasListeners</p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8715">types.d.ts:8715</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="id-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">id</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the id value from the data object.</p>
66
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></h4><p>The id value.</p>
67
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10115">types.d.ts:10115</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_data" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_data</span></a><a href="#_debounce" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_debounce</span></a><a href="#_dropchanges" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_drop<wbr/>Changes</span></a><a href="#_prevdata" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_prev<wbr/>Data</span></a><a href="#emit" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a><a href="#getlisteners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Listeners</span></a><a href="#handlechange" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Change</span></a><a href="#handledropchanges" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Drop<wbr/>Changes</span></a><a href="#once" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a><a href="#refresh" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a><a href="#setdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a><a href="#subscribe" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe</span></a><a href="#toobject" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a><a href="#unsubscribe" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a><a href="#unsubscribeall" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>All</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#data" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a><a href="#haslisteners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Listeners</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.EntityNotFoundError.html ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EntityNotFoundError | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.EntityNotFoundError.html">EntityNotFoundError</a></li></ul><h1>Class EntityNotFoundError</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="4560"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">EntityNotFoundError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10299">types.d.ts:10299</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.EntityNotFoundError.html#constructor" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.EntityNotFoundError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a>
3
+ <a href="types.react-declarative.EntityNotFoundError.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
4
+ <a href="types.react-declarative.EntityNotFoundError.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
5
+ <a href="types.react-declarative.EntityNotFoundError.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link"><a id="constructorentitynotfounderror" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">EntityNotFoundError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.EntityNotFoundError.html" class="tsd-signature-type tsd-kind-class">EntityNotFoundError</a><a href="#constructorentitynotfounderror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.EntityNotFoundError.html" class="tsd-signature-type tsd-kind-class">EntityNotFoundError</a></h4><aside class="tsd-sources"><p>Inherited from Error.constructor</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1082</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link"><a id="constructorentitynotfounderror-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">EntityNotFoundError</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ErrorOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.EntityNotFoundError.html" class="tsd-signature-type tsd-kind-class">EntityNotFoundError</a><a href="#constructorentitynotfounderror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">ErrorOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.EntityNotFoundError.html" class="tsd-signature-type tsd-kind-class">EntityNotFoundError</a></h4><aside class="tsd-sources"><p>Inherited from Error.constructor</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1082</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from Error.cause</p><ul><li>Defined in node_modules/typescript/lib/lib.es2022.error.d.ts:26</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.ErrorBoundary.html ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ErrorBoundary | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.ErrorBoundary.html">ErrorBoundary</a></li></ul><h1>Class ErrorBoundary</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an error boundary component in React.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="1345"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.ErrorBoundary">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../variables/types.react-declarative.dayjs.html" class="tsd-signature-type tsd-kind-variable">dayjs</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IErrorBoundaryProps</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">IErrorBoundaryState</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ErrorBoundary</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22325">types.d.ts:22325</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.ErrorBoundary.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.ErrorBoundary.html#componentdidcatch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Catch</span></a>
4
+ <a href="types.react-declarative.ErrorBoundary.html#componentdidmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a>
5
+ <a href="types.react-declarative.ErrorBoundary.html#componentdidupdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Update</span></a>
6
+ <a href="types.react-declarative.ErrorBoundary.html#componentwillunmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a>
7
+ <a href="types.react-declarative.ErrorBoundary.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a>
8
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="types.react-declarative.ErrorBoundary.html#getderivedstatefromerror" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Derived<wbr/>State<wbr/>From<wbr/>Error</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorerrorboundary" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ErrorBoundary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IErrorBoundaryProps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.ErrorBoundary.html" class="tsd-signature-type tsd-kind-class">ErrorBoundary</a><a href="#constructorerrorboundary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">IErrorBoundaryProps</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.ErrorBoundary.html" class="tsd-signature-type tsd-kind-class">ErrorBoundary</a></h4><aside class="tsd-sources"><p>Overrides React.Component&lt;
10
+ IErrorBoundaryProps,
11
+ IErrorBoundaryState
12
+ &gt;.constructor</p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22339">types.d.ts:22339</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="componentdidcatch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Catch</span><a href="#componentdidcatch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentDidCatch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">errorInfo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Handles error caught during rendering in React components.</p>
13
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">errorInfo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The error object that was caught.</p>
14
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">errorInfo</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Additional information about the error.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-memberof"><h4 class="tsd-anchor-link"><a id="memberof" class="tsd-anchor"></a>Memberof<a href="#memberof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[ComponentName]</p>
16
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22371">types.d.ts:22371</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="componentdidmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Mount</span><a href="#componentdidmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentDidMount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Listen for error cancelation</p>
17
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>componentDidMount</p>
18
+ </div><div class="tsd-tag-memberof"><h4 class="tsd-anchor-link"><a id="memberof-1" class="tsd-anchor"></a>Memberof<a href="#memberof-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Component</p>
19
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22347">types.d.ts:22347</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="componentdidupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Update</span><a href="#componentdidupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentDidUpdate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Listens for updates to the component and handles error state.</p>
20
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-1" class="tsd-anchor"></a>Function<a href="#function-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>componentDidUpdate</p>
21
+ </div><div class="tsd-tag-memberof"><h4 class="tsd-anchor-link"><a id="memberof-2" class="tsd-anchor"></a>Memberof<a href="#memberof-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Component</p>
22
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22363">types.d.ts:22363</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="componentwillunmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Will<wbr/>Unmount</span><a href="#componentwillunmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentWillUnmount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the garbage</p>
23
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-2" class="tsd-anchor"></a>Function<a href="#function-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>componentWillUnmount</p>
24
+ </div><div class="tsd-tag-memberof"><h4 class="tsd-anchor-link"><a id="memberof-3" class="tsd-anchor"></a>Memberof<a href="#memberof-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Component</p>
25
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22355">types.d.ts:22355</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">render</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">ReactNode</span></div><div class="tsd-comment tsd-typography"><p>A function that renders the children component.
26
+ If there is an error in the state, it will return null.
27
+ Otherwise, it will return the children component.</p>
28
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReactNode</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><p>The rendered component or null if there is an error in the state.</p>
29
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22378">types.d.ts:22378</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="getderivedstatefromerror" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>get<wbr/>Derived<wbr/>State<wbr/>From<wbr/>Error</span><a href="#getderivedstatefromerror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getderivedstatefromerror-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getDerivedStateFromError</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">hasError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><a href="#getderivedstatefromerror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an object that represents the new state for a component when an error is thrown during rendering.
30
+ This is a static method that can be implemented in a React class component.</p>
31
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">hasError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></h4><p>The new state object with the 'hasError' property set to true.</p>
32
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-3" class="tsd-anchor"></a>Function<a href="#function-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22336">types.d.ts:22336</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#componentdidcatch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Catch</span></a><a href="#componentdidmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a><a href="#componentdidupdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Update</span></a><a href="#componentwillunmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getderivedstatefromerror" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Derived<wbr/>State<wbr/>From<wbr/>Error</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.EventEmitter.html ADDED
@@ -0,0 +1,34 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EventEmitter | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.EventEmitter.html">EventEmitter</a></li></ul><h1>Class EventEmitter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing an event emitter.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="3738"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.EventEmitter">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">EventEmitter</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a></li><li class="tsd-hierarchy-item"><a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8709">types.d.ts:8709</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.EventEmitter.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.EventEmitter.html#emit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a>
4
+ <a href="types.react-declarative.EventEmitter.html#getlisteners" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Listeners</span></a>
5
+ <a href="types.react-declarative.EventEmitter.html#once" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a>
6
+ <a href="types.react-declarative.EventEmitter.html#subscribe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe</span></a>
7
+ <a href="types.react-declarative.EventEmitter.html#unsubscribe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a>
8
+ <a href="types.react-declarative.EventEmitter.html#unsubscribeall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>All</span></a>
9
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative.EventEmitter.html#haslisteners" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Listeners</span></a>
10
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructoreventemitter" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">EventEmitter</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.EventEmitter.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a><a href="#constructoreventemitter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.EventEmitter.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Emits the given event with the specified arguments.</p>
11
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The name of the event to emit.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The arguments to pass to the event listeners.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
14
+ <li>A promise that resolves when all event listeners have completed.</li>
15
+ </ul>
16
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8760">types.d.ts:8760</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getlisteners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Listeners</span><a href="#getlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getListeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the listeners associated with the given event key.</p>
17
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The event key to retrieve the listeners for.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4><p>An array of listeners associated with the given event key.</p>
19
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8722">types.d.ts:8722</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">once</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Subscribes a callback function to the given event name. The callback function will be triggered only once when the event is emitted.</p>
20
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The name of the event to subscribe to.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to be executed when the event is emitted.</p>
22
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h4><ul>
23
+ <li>A function that can be called to unsubscribe the callback function from the event.</li>
24
+ </ul>
25
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8752">types.d.ts:8752</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">subscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Subscribes a callback function to the specified event name.</p>
26
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The key of the event.</p>
27
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to be executed when the event is triggered.</p>
28
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8730">types.d.ts:8730</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsubscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe</span><a href="#unsubscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsubscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Removes a callback function from the list of event listeners for the specified event.</p>
29
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The key of the event to unsubscribe from.</p>
30
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to remove from the event listeners.</p>
31
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8738">types.d.ts:8738</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsubscribeall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>All</span><a href="#unsubscribeall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsubscribeAll</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears all event handlers registered for the current object.</p>
32
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8744">types.d.ts:8744</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="haslisteners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Listeners</span><a href="#haslisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="haslisteners-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hasListeners</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if the object has any listeners attached to it.</p>
33
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the object has listeners, false otherwise.</p>
34
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8715">types.d.ts:8715</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#emit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a><a href="#getlisteners" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Listeners</span></a><a href="#once" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a><a href="#subscribe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe</span></a><a href="#unsubscribe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a><a href="#unsubscribeall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>All</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#haslisteners" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Listeners</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.FetchError.html ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FetchError | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.FetchError.html">FetchError</a></li></ul><h1>Class FetchError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an error that occurs during a fetch request.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="3302"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FetchError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L7893">types.d.ts:7893</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.FetchError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.FetchError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a>
4
+ <a href="types.react-declarative.FetchError.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
5
+ <a href="types.react-declarative.FetchError.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
6
+ <a href="types.react-declarative.FetchError.html#originalerror" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>original<wbr/>Error</span></a>
7
+ <a href="types.react-declarative.FetchError.html#request" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a>
8
+ <a href="types.react-declarative.FetchError.html#response" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a>
9
+ <a href="types.react-declarative.FetchError.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a>
10
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorfetcherror" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">FetchError</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">originalError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RequestInfo</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.FetchError.html" class="tsd-signature-type tsd-kind-class">FetchError</a><a href="#constructorfetcherror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">originalError</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">RequestInfo</span></span></li><li><span><span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Response</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.FetchError.html" class="tsd-signature-type tsd-kind-class">FetchError</a></h4><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L7897">types.d.ts:7897</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from Error.cause</p><ul><li>Defined in node_modules/typescript/lib/lib.es2022.error.d.ts:26</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="originalerror" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>original<wbr/>Error</span><a href="#originalerror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">originalError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L7894">types.d.ts:7894</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RequestInfo</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L7895">types.d.ts:7895</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Response</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L7896">types.d.ts:7896</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#originalerror" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>original<wbr/>Error</span></a><a href="#request" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.Model.html ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Model | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.Model.html">Model</a></li></ul><h1>Class Model&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing a model.</p>
2
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-implements"><h4 class="tsd-anchor-link"><a id="implements" class="tsd-anchor"></a>Implements<a href="#implements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>IModelAdapter</p>
3
+ </div></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">{}</span> = <span class="tsd-signature-type">any</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="4649"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.Model">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="types.react-declarative.EventEmitter.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Model</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a></li></ul></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html" class="tsd-signature-type tsd-kind-interface">IModelAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10540">types.d.ts:10540</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.Model.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.Model.html#_data" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_data</span></a>
5
+ <a href="types.react-declarative.Model.html#_debounce" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_debounce</span></a>
6
+ <a href="types.react-declarative.Model.html#_dropchanges" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_drop<wbr/>Changes</span></a>
7
+ <a href="types.react-declarative.Model.html#_prevdata" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_prev<wbr/>Data</span></a>
8
+ <a href="types.react-declarative.Model.html#emit" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a>
9
+ <a href="types.react-declarative.Model.html#getlisteners" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Listeners</span></a>
10
+ <a href="types.react-declarative.Model.html#handledropchanges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Drop<wbr/>Changes</span></a>
11
+ <a href="types.react-declarative.Model.html#once" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a>
12
+ <a href="types.react-declarative.Model.html#refresh" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a>
13
+ <a href="types.react-declarative.Model.html#subscribe" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe</span></a>
14
+ <a href="types.react-declarative.Model.html#toobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a>
15
+ <a href="types.react-declarative.Model.html#unsubscribe" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a>
16
+ <a href="types.react-declarative.Model.html#unsubscribeall" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>All</span></a>
17
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative.Model.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a>
18
+ <a href="types.react-declarative.Model.html#haslisteners" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Listeners</span></a>
19
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="types.react-declarative.Model.html#handlechange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>handle<wbr/>Change</span></a>
20
+ <a href="types.react-declarative.Model.html#setdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Data</span></a>
21
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructormodel" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Model</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{}</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">_data</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_debounce</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_prevData</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructormodel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructormodelt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">{}</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_data</span>: <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_debounce</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_prevData</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Overrides <a href="types.react-declarative.EventEmitter.html">EventEmitter</a>.<a href="types.react-declarative.EventEmitter.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10554">types.d.ts:10554</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_data</span><a href="#_data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_data</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10547">types.d.ts:10547</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_debounce" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_debounce</span><a href="#_debounce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_debounce</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10544">types.d.ts:10544</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_dropchanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_drop<wbr/>Changes</span><a href="#_dropchanges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_dropChanges</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10546">types.d.ts:10546</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_prevdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_prev<wbr/>Data</span><a href="#_prevdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_prevData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10545">types.d.ts:10545</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Emits the given event with the specified arguments.</p>
22
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The name of the event to emit.</p>
23
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The arguments to pass to the event listeners.</p>
24
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
25
+ <li>A promise that resolves when all event listeners have completed.</li>
26
+ </ul>
27
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.EventEmitter.html">EventEmitter</a>.<a href="types.react-declarative.EventEmitter.html#emit">emit</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8760">types.d.ts:8760</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getlisteners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Listeners</span><a href="#getlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getListeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the listeners associated with the given event key.</p>
28
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The event key to retrieve the listeners for.</p>
29
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4><p>An array of listeners associated with the given event key.</p>
30
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.EventEmitter.html">EventEmitter</a>.<a href="types.react-declarative.EventEmitter.html#getlisteners">getListeners</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8722">types.d.ts:8722</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="handledropchanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>handle<wbr/>Drop<wbr/>Changes</span><a href="#handledropchanges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">handleDropChanges</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Handles the changes when an item is dropped.</p>
31
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>handleDropChanges</p>
32
+ </div><div class="tsd-tag-memberof"><h4 class="tsd-anchor-link"><a id="memberof" class="tsd-anchor"></a>Memberof<a href="#memberof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ClassName</p>
33
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10585">types.d.ts:10585</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">once</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Subscribes a callback function to the given event name. The callback function will be triggered only once when the event is emitted.</p>
34
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The name of the event to subscribe to.</p>
35
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to be executed when the event is emitted.</p>
36
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h4><ul>
37
+ <li>A function that can be called to unsubscribe the callback function from the event.</li>
38
+ </ul>
39
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.EventEmitter.html">EventEmitter</a>.<a href="types.react-declarative.EventEmitter.html#once">once</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8752">types.d.ts:8752</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="refresh" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh</span><a href="#refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">refresh</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>A function that triggers a refresh event.</p>
40
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-1" class="tsd-anchor"></a>Function<a href="#function-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-memberOf"><h4 class="tsd-anchor-link"><a id="member-of" class="tsd-anchor"></a>Member Of<a href="#member-of" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>global</p>
41
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#refresh">refresh</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10593">types.d.ts:10593</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">subscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Subscribes a callback function to the specified event name.</p>
42
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The key of the event.</p>
43
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to be executed when the event is triggered.</p>
44
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.EventEmitter.html">EventEmitter</a>.<a href="types.react-declarative.EventEmitter.html#subscribe">subscribe</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8730">types.d.ts:8730</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toobject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></div><div class="tsd-comment tsd-typography"><p>Converts the object into a plain JavaScript object.</p>
45
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></h4><ul>
46
+ <li>The plain JavaScript object representation.</li>
47
+ </ul>
48
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-2" class="tsd-anchor"></a>Function<a href="#function-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#toobject">toObject</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10600">types.d.ts:10600</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unsubscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe</span><a href="#unsubscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsubscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Removes a callback function from the list of event listeners for the specified event.</p>
49
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventKey</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">EventKey</span></span><div class="tsd-comment tsd-typography"><p>The key of the event to unsubscribe from.</p>
50
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The callback function to remove from the event listeners.</p>
51
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.EventEmitter.html">EventEmitter</a>.<a href="types.react-declarative.EventEmitter.html#unsubscribe">unsubscribe</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8738">types.d.ts:8738</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unsubscribeall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>All</span><a href="#unsubscribeall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsubscribeAll</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears all event handlers registered for the current object.</p>
52
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-3" class="tsd-anchor"></a>Function<a href="#function-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Inherited from <a href="types.react-declarative.EventEmitter.html">EventEmitter</a>.<a href="types.react-declarative.EventEmitter.html#unsubscribeall">unsubscribeAll</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8744">types.d.ts:8744</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="data-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">data</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the value of the data property.</p>
53
+ </div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a></h4><p>The frozen data.</p>
54
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10553">types.d.ts:10553</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="haslisteners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Listeners</span><a href="#haslisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature" id="haslisteners-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hasListeners</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if the object has any listeners attached to it.</p>
55
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the object has listeners, false otherwise.</p>
56
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from EventEmitter.hasListeners</p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8715">types.d.ts:8715</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="handlechange" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>handle<wbr/>Change</span><a href="#handlechange" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="handlechange-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">handleChange</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">change</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><a href="#handlechange-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Handles changes made to the Model.</p>
57
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">change</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>The callback function to be executed when a change occurs in the Model.
58
+ It accepts a single parameter representing the changed item of type Model<T>.</p>
59
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h4><ul>
60
+ <li>A cleanup function that unsubscribes the callback from the CHANGE_SYMBOL event,
61
+ unsubscribes the callback from the REFRESH_SYMBOL event, clears the debounce function,
62
+ and unsubscribes the drop function.</li>
63
+ </ul>
64
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10577">types.d.ts:10577</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Data</span><a href="#setdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setdata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setdata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the data for the object.</p>
65
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative.Model.html#constructormodelt">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to be set. It can be a partial object or a function that takes the previous data and returns a partial object.</p>
66
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#setdata">setData</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10566">types.d.ts:10566</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_data" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_data</span></a><a href="#_debounce" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_debounce</span></a><a href="#_dropchanges" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_drop<wbr/>Changes</span></a><a href="#_prevdata" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_prev<wbr/>Data</span></a><a href="#emit" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emit</span></a><a href="#getlisteners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Listeners</span></a><a href="#handledropchanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handle<wbr/>Drop<wbr/>Changes</span></a><a href="#once" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>once</span></a><a href="#refresh" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a><a href="#subscribe" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe</span></a><a href="#toobject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a><a href="#unsubscribe" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a><a href="#unsubscribeall" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>All</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a><a href="#haslisteners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Listeners</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#handlechange" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>handle<wbr/>Change</span></a><a href="#setdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Data</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.NoSsr.html ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NoSsr | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.NoSsr.html">NoSsr</a></li></ul><h1>Class NoSsr</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a component that handles server-side rendering (SSR) and client-side rendering (CSR) conditionally.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="2053"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.NoSsr">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../variables/types.react-declarative.dayjs.html" class="tsd-signature-type tsd-kind-variable">dayjs</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">INoSsrProps</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">NoSsr</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L21883">types.d.ts:21883</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.NoSsr.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.NoSsr.html#componentdidmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a>
4
+ <a href="types.react-declarative.NoSsr.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructornossr" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">NoSsr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">INoSsrProps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.NoSsr.html" class="tsd-signature-type tsd-kind-class">NoSsr</a><a href="#constructornossr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">INoSsrProps</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.NoSsr.html" class="tsd-signature-type tsd-kind-class">NoSsr</a></h4><aside class="tsd-sources"><p>Overrides React.Component&lt;INoSsrProps, State&gt;.constructor</p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L21884">types.d.ts:21884</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="componentdidmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Mount</span><a href="#componentdidmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentDidMount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L21885">types.d.ts:21885</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">render</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Element</span></div><div class="tsd-comment tsd-typography"><p>Renders the content based on the current state.</p>
6
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Element</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><p>The rendered content.</p>
7
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L21891">types.d.ts:21891</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#componentdidmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.Observer.html ADDED
The diff for this file is too large to render. See raw diff
 
classes/types.react-declarative.OneConfig.html ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OneConfig | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.OneConfig.html">OneConfig</a></li></ul><h1>Class OneConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing the OneConfig.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L30683">types.d.ts:30683</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.OneConfig.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.OneConfig.html#get_ref_symbol" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[GET_<wbr/>REF_<wbr/>SYMBOL]</span></a>
4
+ <a href="types.react-declarative.OneConfig.html#setvalue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Value</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructoroneconfig" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">OneConfig</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.OneConfig.html" class="tsd-signature-type tsd-kind-class">OneConfig</a><a href="#constructoroneconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.OneConfig.html" class="tsd-signature-type tsd-kind-class">OneConfig</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="get_ref_symbol" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>[GET_<wbr/>REF_<wbr/>SYMBOL]</span><a href="#get_ref_symbol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">&quot;[GET_REF_SYMBOL]&quot;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="../interfaces/types.react-declarative_components_One_components_OneConfig.IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L30684">types.d.ts:30684</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setvalue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>set<wbr/>Value</span><a href="#setvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setValue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components_One_components_OneConfig.IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L30685">types.d.ts:30685</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#get_ref_symbol" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[GET_<wbr/>REF_<wbr/>SYMBOL]</span></a><a href="#setvalue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Value</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.Operator.html ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Operator | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.Operator.html">Operator</a></li></ul><h1>Class Operator</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a collection of static operator functions.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8969">types.d.ts:8969</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.Operator.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.Operator.html#count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a>
4
+ <a href="types.react-declarative.Operator.html#distinct" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>distinct</span></a>
5
+ <a href="types.react-declarative.Operator.html#group" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group</span></a>
6
+ <a href="types.react-declarative.Operator.html#liveness" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>liveness</span></a>
7
+ <a href="types.react-declarative.Operator.html#pair" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pair</span></a>
8
+ <a href="types.react-declarative.Operator.html#skip" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip</span></a>
9
+ <a href="types.react-declarative.Operator.html#stridetricks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stride<wbr/>Tricks</span></a>
10
+ <a href="types.react-declarative.Operator.html#take" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>take</span></a>
11
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructoroperator" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Operator</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Operator.html" class="tsd-signature-type tsd-kind-class">Operator</a><a href="#constructoroperator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Operator.html" class="tsd-signature-type tsd-kind-class">Operator</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>count</span><a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L9007">types.d.ts:9007</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="distinct" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>distinct</span><a href="#distinct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">distinct</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">getCompareValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8996">types.d.ts:8996</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="group" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>group</span><a href="#group" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">group</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">by</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8985">types.d.ts:8985</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="liveness" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>liveness</span><a href="#liveness" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">liveness</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fallbackfn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">waitFor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L9001">types.d.ts:9001</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pair" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>pair</span><a href="#pair" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pair</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">by</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8980">types.d.ts:8980</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="skip" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>skip</span><a href="#skip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">skip</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">the</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8975">types.d.ts:8975</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stridetricks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>stride<wbr/>Tricks</span><a href="#stridetricks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">strideTricks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">strideSize</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">step</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8990">types.d.ts:8990</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="take" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>take</span><a href="#take" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">take</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8970">types.d.ts:8970</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a><a href="#distinct" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>distinct</span></a><a href="#group" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group</span></a><a href="#liveness" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>liveness</span></a><a href="#pair" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pair</span></a><a href="#skip" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip</span></a><a href="#stridetricks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stride<wbr/>Tricks</span></a><a href="#take" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>take</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.PortalView.html ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PortalView | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.PortalView.html">PortalView</a></li></ul><h1>Class PortalView</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a portal view component.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="1094"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.PortalView">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../variables/types.react-declarative.dayjs.html" class="tsd-signature-type tsd-kind-variable">dayjs</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IPortalViewProps</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PortalView</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26524">types.d.ts:26524</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.PortalView.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.PortalView.html#element" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>element</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="types.react-declarative.PortalView.html#componentwillunmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a>
5
+ <a href="types.react-declarative.PortalView.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorportalview" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">PortalView</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.PortalView.html" class="tsd-signature-type tsd-kind-class">PortalView</a><a href="#constructorportalview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.PortalView.html" class="tsd-signature-type tsd-kind-class">PortalView</a></h4><aside class="tsd-sources"><p>Inherited from React.Component&lt;IPortalViewProps&gt;.constructor</p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="element" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>element</span><a href="#element" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">element</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLDivElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26525">types.d.ts:26525</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="componentwillunmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Will<wbr/>Unmount</span><a href="#componentwillunmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="componentwillunmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillUnmount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentwillunmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Method componentWillUnmount</p>
7
+ <p>This method is called when the component is about to be unmounted (removed) from the DOM.
8
+ It performs clean-up tasks, if any, to avoid memory leaks or unwanted effects after the component is removed.</p>
9
+ <p>This method checks if 'this.element' (assumed to be a DOM element) exists, and if so,
10
+ removes it from the document body using 'document.body.removeChild()'.
11
+ Finally, it sets 'this.element' to null to release any references to the removed element.</p>
12
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26538">types.d.ts:26538</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="render-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">render</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReactPortal</span><a href="#render-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Renders the provided children into a portal, within a dynamically created div element appended to the document body.</p>
13
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactPortal</span></h4><ul>
14
+ <li>The resulting React element after rendering the children into the portal.</li>
15
+ </ul>
16
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26544">types.d.ts:26544</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#element" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>element</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#componentwillunmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.ReloadView.html ADDED
@@ -0,0 +1,18 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ReloadView | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.ReloadView.html">ReloadView</a></li></ul><h1>Class ReloadView</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a reload view component.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="1102"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.ReloadView">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../variables/types.react-declarative.dayjs.html" class="tsd-signature-type tsd-kind-variable">dayjs</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IReloadViewProps</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ReloadView</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26932">types.d.ts:26932</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.ReloadView.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.ReloadView.html#_disconnectlistener" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_disconnect<wbr/>Listener</span></a>
4
+ <a href="types.react-declarative.ReloadView.html#componentdidmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a>
5
+ <a href="types.react-declarative.ReloadView.html#componentdidupdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Update</span></a>
6
+ <a href="types.react-declarative.ReloadView.html#componentwillunmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a>
7
+ <a href="types.react-declarative.ReloadView.html#dosubscribe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Subscribe</span></a>
8
+ <a href="types.react-declarative.ReloadView.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorreloadview" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ReloadView</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.ReloadView.html" class="tsd-signature-type tsd-kind-class">ReloadView</a><a href="#constructorreloadview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.ReloadView.html" class="tsd-signature-type tsd-kind-class">ReloadView</a></h4><aside class="tsd-sources"><p>Inherited from React.Component&lt;IReloadViewProps&gt;.constructor</p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="_disconnectlistener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>_disconnect<wbr/>Listener</span><a href="#_disconnectlistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_disconnectListener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26933">types.d.ts:26933</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="componentdidmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Mount</span><a href="#componentdidmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentDidMount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Invoked immediately after a component is mounted.</p>
10
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>componentDidMount</p>
11
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26946">types.d.ts:26946</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="componentdidupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Update</span><a href="#componentdidupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentDidUpdate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Executes the necessary operations after the component is updated.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26950">types.d.ts:26950</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="componentwillunmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Will<wbr/>Unmount</span><a href="#componentwillunmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentWillUnmount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Component lifecycle method that is called just before the component is unmounted and destroyed.
13
+ It is used to perform any necessary cleanup logic or clean up any resources that were previously allocated by this component.</p>
14
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26955">types.d.ts:26955</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dosubscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Subscribe</span><a href="#dosubscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">doSubscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Unsubscribes from previous reloadTrigger subscription and subscribes to a new reloadTrigger subscription.
15
+ Whenever reloadTrigger emits a value, it forces the component to update.</p>
16
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-method"><h4 class="tsd-anchor-link"><a id="method" class="tsd-anchor"></a>Method<a href="#method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>doSubscribe</p>
17
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26940">types.d.ts:26940</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">render</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Element</span></div><div class="tsd-comment tsd-typography"><p>Render lifecycle method</p>
18
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L26959">types.d.ts:26959</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_disconnectlistener" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_disconnect<wbr/>Listener</span></a><a href="#componentdidmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a><a href="#componentdidupdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Update</span></a><a href="#componentwillunmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a><a href="#dosubscribe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Subscribe</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.RouteManager.html ADDED
The diff for this file is too large to render. See raw diff
 
classes/types.react-declarative.Source.html ADDED
The diff for this file is too large to render. See raw diff
 
classes/types.react-declarative.Subject.html ADDED
The diff for this file is too large to render. See raw diff
 
classes/types.react-declarative.SubjectBinding.html ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SubjectBinding | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.SubjectBinding.html">SubjectBinding</a></li></ul><h1>Class SubjectBinding</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A React component that binds to a subject and updates when the subject emits a value.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="2027"><h4>Hierarchy (<a href="../hierarchy.html#types.react-declarative.SubjectBinding">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../variables/types.react-declarative.dayjs.html" class="tsd-signature-type tsd-kind-variable">dayjs</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ISubjectBindingProps</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SubjectBinding</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L28738">types.d.ts:28738</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.SubjectBinding.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.SubjectBinding.html#componentdidmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a>
4
+ <a href="types.react-declarative.SubjectBinding.html#componentwillunmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a>
5
+ <a href="types.react-declarative.SubjectBinding.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorsubjectbinding" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">SubjectBinding</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.SubjectBinding.html" class="tsd-signature-type tsd-kind-class">SubjectBinding</a><a href="#constructorsubjectbinding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.SubjectBinding.html" class="tsd-signature-type tsd-kind-class">SubjectBinding</a></h4><aside class="tsd-sources"><p>Inherited from React.Component&lt;ISubjectBindingProps&gt;.constructor</p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="componentdidmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Mount</span><a href="#componentdidmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentDidMount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L28739">types.d.ts:28739</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="componentwillunmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Will<wbr/>Unmount</span><a href="#componentwillunmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">componentWillUnmount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L28740">types.d.ts:28740</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">render</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Element</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L28741">types.d.ts:28741</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#componentdidmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a><a href="#componentwillunmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.Task.html ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Task | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.Task.html">Task</a></li></ul><h1>Class Task</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A class representing a task.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8334">types.d.ts:8334</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.Task.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.Task.html#target" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative.Task.html#status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>status</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructortask" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Task.html" class="tsd-signature-type tsd-kind-class">Task</a><a href="#constructortask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructor for creating an instance of the class.</p>
6
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The target promise to be handled.</p>
7
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Task.html" class="tsd-signature-type tsd-kind-class">Task</a></h4><ul>
8
+ <li>This method does not return any value.</li>
9
+ </ul>
10
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8349">types.d.ts:8349</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="target" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>target</span><a href="#target" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8335">types.d.ts:8335</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="status-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">status</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pending&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;fulfilled&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rejected&quot;</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the current status value.</p>
11
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;pending&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;fulfilled&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rejected&quot;</span></h4><p>The value of the status.</p>
12
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L8341">types.d.ts:8341</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#target" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>status</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.Translate.html ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Translate | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.Translate.html">Translate</a></li></ul><h1>Class Translate</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Translate class for handling text translation and transformation.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22159">types.d.ts:22159</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative.Translate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.Translate.html#clear" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear</span></a>
4
+ <a href="types.react-declarative.Translate.html#config" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a>
5
+ <a href="types.react-declarative.Translate.html#createelement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Element</span></a>
6
+ <a href="types.react-declarative.Translate.html#install" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>install</span></a>
7
+ <a href="types.react-declarative.Translate.html#jss" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jss</span></a>
8
+ <a href="types.react-declarative.Translate.html#translatetext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>translate<wbr/>Text</span></a>
9
+ <a href="types.react-declarative.Translate.html#use" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use</span></a>
10
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative.Translate.html#skiplist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>skip<wbr/>List</span></a>
11
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructortranslate" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Translate</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">locale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Locale</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">transform</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.ITranslateConfig.html" class="tsd-signature-type tsd-kind-interface">ITranslateConfig</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Translate.html" class="tsd-signature-type tsd-kind-class">Translate</a><a href="#constructortranslate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructs a new instance of the Translator class.</p>
12
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">locale</span>: <span class="tsd-signature-type">Locale</span></span><div class="tsd-comment tsd-typography"><p>An object representing the initial locale configuration.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">transform</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A function for transforming strings.</p>
14
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.ITranslateConfig.html" class="tsd-signature-type tsd-kind-interface">ITranslateConfig</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>An object representing additional configuration options.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Translate.html" class="tsd-signature-type tsd-kind-class">Translate</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22177">types.d.ts:22177</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="clear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear</span><a href="#clear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clear</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clear the _skip and _transformed variables.</p>
16
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22225">types.d.ts:22225</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.ITranslateConfig.html" class="tsd-signature-type tsd-kind-interface">ITranslateConfig</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22160">types.d.ts:22160</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="createelement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Element</span><a href="#createelement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createElement</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IAttributeCollection</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">children</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Creates and returns an element based on the provided type, props, and children.</p>
17
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IAttributeCollection</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">children</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The type of the element to create.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IAttributeCollection</span></span><div class="tsd-comment tsd-typography"><p>The properties or attributes to assign to the element.</p>
19
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">children</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The child elements or content to append to the element.</p>
20
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><ul>
21
+ <li>The created element.</li>
22
+ </ul>
23
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22196">types.d.ts:22196</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="install" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>install</span><a href="#install" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">install</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><br/>        locale<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Locale</span><span class="tsd-signature-symbol">,</span><br/>        transform<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        config<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.ITranslateConfig.html" class="tsd-signature-type tsd-kind-interface">ITranslateConfig</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="types.react-declarative.Translate.html" class="tsd-signature-type tsd-kind-class">Translate</a></div><div class="tsd-comment tsd-typography"><p>Installs the Translate object and configures React.</p>
24
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><br/>        locale<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Locale</span><span class="tsd-signature-symbol">,</span><br/>        transform<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        config<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.ITranslateConfig.html" class="tsd-signature-type tsd-kind-interface">ITranslateConfig</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Translate.html" class="tsd-signature-type tsd-kind-class">Translate</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-symbol">[</span><br/>    locale<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Locale</span><span class="tsd-signature-symbol">,</span><br/>    transform<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    config<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components.ITranslateConfig.html" class="tsd-signature-type tsd-kind-interface">ITranslateConfig</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>The parameters needed to create a new Translate instance.</p>
25
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Translate.html" class="tsd-signature-type tsd-kind-class">Translate</a></h4><p>The installed Translate object.</p>
26
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22217">types.d.ts:22217</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="jss" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>jss</span><a href="#jss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">jss</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IAttributeCollection</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">ReactElement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Create an element using the given type and props</p>
27
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IAttributeCollection</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReactElement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The type of the element</p>
28
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IAttributeCollection</span></span><div class="tsd-comment tsd-typography"><p>The props for the element</p>
29
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactElement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
30
+ <li>The created element</li>
31
+ </ul>
32
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22207">types.d.ts:22207</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="translatetext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>translate<wbr/>Text</span><a href="#translatetext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">translateText</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Translates the given text to another language.</p>
33
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The text to be translated.</p>
34
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The translated text.</p>
35
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22168">types.d.ts:22168</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="use" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>use</span><a href="#use" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">middleware</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Adds a middleware to the list of used middlewares.</p>
36
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">middleware</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">middleware</span>: <span class="tsd-signature-type">Middleware</span></span><div class="tsd-comment tsd-typography"><p>The middleware to be added.</p>
37
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22187">types.d.ts:22187</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="skiplist" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>skip<wbr/>List</span><a href="#skiplist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="skiplist-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">skipList</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L22161">types.d.ts:22161</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#clear" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear</span></a><a href="#config" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#createelement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Element</span></a><a href="#install" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>install</span></a><a href="#jss" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jss</span></a><a href="#translatetext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>translate<wbr/>Text</span></a><a href="#use" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#skiplist" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>skip<wbr/>List</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative.serviceManager.html ADDED
@@ -0,0 +1,49 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>serviceManager | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative.html">react-declarative</a></li><li><a href="types.react-declarative.serviceManager.html">serviceManager</a></li></ul><h1>Class serviceManager</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An implementation of the IServiceManager interface.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4544">types.d.ts:4544</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative.serviceManager.html#_servicemanager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_service<wbr/>Manager</span></a>
3
+ <a href="types.react-declarative.serviceManager.html#clear" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear</span></a>
4
+ <a href="types.react-declarative.serviceManager.html#disableuml" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disableUML</span></a>
5
+ <a href="types.react-declarative.serviceManager.html#inject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inject</span></a>
6
+ <a href="types.react-declarative.serviceManager.html#prefetch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prefetch</span></a>
7
+ <a href="types.react-declarative.serviceManager.html#registercreator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>register<wbr/>Creator</span></a>
8
+ <a href="types.react-declarative.serviceManager.html#registerinstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>register<wbr/>Instance</span></a>
9
+ <a href="types.react-declarative.serviceManager.html#touml" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toUML</span></a>
10
+ <a href="types.react-declarative.serviceManager.html#unload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unload</span></a>
11
+ <a href="types.react-declarative.serviceManager.html#waitforprovide" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wait<wbr/>For<wbr/>Provide</span></a>
12
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="_servicemanager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>_service<wbr/>Manager</span><a href="#_servicemanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_serviceManager</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ServiceManager</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4545">types.d.ts:4545</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="clear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>clear</span><a href="#clear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clear</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the service.</p>
13
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>Returns nothing.</p>
14
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-memberOf"><h4 class="tsd-anchor-link"><a id="member-of" class="tsd-anchor"></a>Member Of<a href="#member-of" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>SomeClass</p>
15
+ </div><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-name"><h4 class="tsd-anchor-link"><a id="name" class="tsd-anchor"></a>Name<a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>clear</p>
16
+ </div><div class="tsd-tag-instance"><h4 class="tsd-anchor-link"><a id="instance" class="tsd-anchor"></a>Instance<a href="#instance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4604">types.d.ts:4604</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="disableuml" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>disableUML</span><a href="#disableuml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disableUML</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Disable UML log collection. Increase performance
17
+ on production</p>
18
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4616">types.d.ts:4616</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="inject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>inject</span><a href="#inject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a></div><div class="tsd-comment tsd-typography"><p>Injects a dependency using the given key and returns an instance of the dependency.</p>
19
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>The type of the dependency being injected.</p>
20
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Key</span></span><div class="tsd-comment tsd-typography"><p>The key used to locate the dependency.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">verbose</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>A flag indicating whether verbose logging should be enabled (default is true).</p>
22
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a></h4><ul>
23
+ <li>An instance of the dependency.</li>
24
+ </ul>
25
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4570">types.d.ts:4570</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="prefetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>prefetch</span><a href="#prefetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prefetch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Prefetches data using the <code>_serviceManager.prefetch</code> method.</p>
26
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">verbose</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Specifies whether to enable verbose mode.</p>
27
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
28
+ <li>A promise that resolves when the prefetching is complete.</li>
29
+ </ul>
30
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4585">types.d.ts:4585</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="registercreator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>register<wbr/>Creator</span><a href="#registercreator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">registerCreator</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">ctor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Registers a creator function for a given key.</p>
31
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">ctor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">object</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Key</span></span><div class="tsd-comment tsd-typography"><p>The key to associate with the creator function.</p>
32
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ctor</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The creator function that returns the desired object or a promise resolving to the desired object.</p>
33
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4561">types.d.ts:4561</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="registerinstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>register<wbr/>Instance</span><a href="#registerinstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">registerInstance</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">inst</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Registers an instance with the service manager.</p>
34
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">inst</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">object</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Key</span></span><div class="tsd-comment tsd-typography"><p>The key for the registered instance.</p>
35
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">inst</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="">T</a></span><div class="tsd-comment tsd-typography"><p>The instance to be registered.</p>
36
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4553">types.d.ts:4553</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="touml" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>toUML</span><a href="#touml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toUML</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Converts a resolution tree to a YAML UML representation.
37
+ Prints the UML representation to the console and returns it as a string.</p>
38
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The YAML UML representation of the resolution tree.</p>
39
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4611">types.d.ts:4611</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>unload</span><a href="#unload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Unloads a resource using the _serviceManager.</p>
40
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">verbose</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to output verbose information. Default value is true.</p>
41
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
42
+ <li>A promise that resolves when the resource is unloaded.</li>
43
+ </ul>
44
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async" class="tsd-anchor"></a>Async<a href="#async" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4593">types.d.ts:4593</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="waitforprovide" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>wait<wbr/>For<wbr/>Provide</span><a href="#waitforprovide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">waitForProvide</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Wait for the service to be provided.</p>
45
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">verbose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">verbose</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to output verbose logs.</p>
46
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
47
+ <li>A promise that resolves when the service is provided.</li>
48
+ </ul>
49
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async-1" class="tsd-anchor"></a>Async<a href="#async-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L4578">types.d.ts:4578</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_servicemanager" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_service<wbr/>Manager</span></a><a href="#clear" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear</span></a><a href="#disableuml" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disableUML</span></a><a href="#inject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inject</span></a><a href="#prefetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prefetch</span></a><a href="#registercreator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>register<wbr/>Creator</span></a><a href="#registerinstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>register<wbr/>Instance</span></a><a href="#touml" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toUML</span></a><a href="#unload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unload</span></a><a href="#waitforprovide" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wait<wbr/>For<wbr/>Provide</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_components.AudioMediaRecorder.html ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AudioMediaRecorder | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_components.html">react-declarative/components</a></li><li><a href="types.react-declarative_components.AudioMediaRecorder.html">AudioMediaRecorder</a></li></ul><h1>Class AudioMediaRecorder</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A singleton class for handling audio recording using the MediaRecorder API.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27587">types.d.ts:27587</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_components.AudioMediaRecorder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="types.react-declarative_components.AudioMediaRecorder.html#getinstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a>
4
+ <a href="types.react-declarative_components.AudioMediaRecorder.html#initialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initialize</span></a>
5
+ <a href="types.react-declarative_components.AudioMediaRecorder.html#startrecord" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Record</span></a>
6
+ <a href="types.react-declarative_components.AudioMediaRecorder.html#stoprecord" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Record</span></a>
7
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructoraudiomediarecorder" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">AudioMediaRecorder</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_components.AudioMediaRecorder.html" class="tsd-signature-type tsd-kind-class">AudioMediaRecorder</a><a href="#constructoraudiomediarecorder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructs an instance of AudioMediaRecorder.
8
+ Throws an error if window.MediaRecorder is undefined.</p>
9
+ </div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_components.AudioMediaRecorder.html" class="tsd-signature-type tsd-kind-class">AudioMediaRecorder</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27597">types.d.ts:27597</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="getinstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>get<wbr/>Instance</span><a href="#getinstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getinstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getInstance</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_components.AudioMediaRecorder.html" class="tsd-signature-type tsd-kind-class">AudioMediaRecorder</a><a href="#getinstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the singleton instance of AudioMediaRecorder.</p>
10
+ </div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_components.AudioMediaRecorder.html" class="tsd-signature-type tsd-kind-class">AudioMediaRecorder</a></h4><p>The singleton instance of AudioMediaRecorder.</p>
11
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27592">types.d.ts:27592</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="initialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>initialize</span><a href="#initialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="initialize-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">initialize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative_components.AudioMediaRecorder.html" class="tsd-signature-type tsd-kind-class">AudioMediaRecorder</a><span class="tsd-signature-symbol">&gt;</span><a href="#initialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes the MediaRecorder instance.</p>
12
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative_components.AudioMediaRecorder.html" class="tsd-signature-type tsd-kind-class">AudioMediaRecorder</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise resolving to the initialized AudioMediaRecorder instance.</p>
13
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27602">types.d.ts:27602</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="startrecord" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Record</span><a href="#startrecord" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="startrecord-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">startRecord</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#startrecord-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts recording audio.</p>
14
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise resolving when recording starts.</p>
15
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Throws an error if the MediaRecorder instance is not initialized.</p>
16
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27608">types.d.ts:27608</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="stoprecord" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stop<wbr/>Record</span><a href="#stoprecord" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="stoprecord-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stopRecord</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">&gt;</span><a href="#stoprecord-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops recording audio.</p>
17
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise resolving to the recorded audio Blob.</p>
18
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-1" class="tsd-anchor"></a>Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Throws an error if the MediaRecorder instance is not initialized.</p>
19
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L27614">types.d.ts:27614</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getinstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a><a href="#initialize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initialize</span></a><a href="#startrecord" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Record</span></a><a href="#stoprecord" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Record</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OneConfigInstance | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_components_One_components_OneConfig_OneConfigInstance.html">react-declarative/components/One/components/OneConfig/OneConfigInstance</a></li><li><a href="types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html">OneConfigInstance</a></li></ul><h1>Class OneConfigInstance</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing a OneConfigInstance.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L33605">types.d.ts:33605</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html#getref" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Ref</span></a>
4
+ <a href="types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html#setvalue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Value</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructoroneconfiginstance" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">OneConfigInstance</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html" class="tsd-signature-type tsd-kind-class">OneConfigInstance</a><a href="#constructoroneconfiginstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_components_One_components_OneConfig_OneConfigInstance.OneConfigInstance.html" class="tsd-signature-type tsd-kind-class">OneConfigInstance</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="getref" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Ref</span><a href="#getref" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getRef</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="../interfaces/types.react-declarative_components_One_components_OneConfig.IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L33606">types.d.ts:33606</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setvalue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Value</span><a href="#setvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setValue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.react-declarative_components_One_components_OneConfig.IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L33607">types.d.ts:33607</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#getref" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Ref</span></a><a href="#setvalue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Value</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_hooks_useCollection.CollectionAdapter.html ADDED
@@ -0,0 +1,110 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CollectionAdapter | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_hooks_useCollection.html">react-declarative/hooks/useCollection</a></li><li><a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html">CollectionAdapter</a></li></ul><h1>Class CollectionAdapter&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>CollectionAdapter class is used to adapt a collection of entities.
2
+ It provides various methods for manipulating and accessing the collection.</p>
3
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-typeparam"><h4 class="tsd-anchor-link"><a id="typeparam" class="tsd-anchor"></a>Typeparam<a href="#typeparam" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>T - The type of entity in the collection</p>
4
+ </div></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html" class="tsd-signature-type tsd-kind-interface">ICollectionAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6499">types.d.ts:6499</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
5
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#clear" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear</span></a>
6
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#filter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter</span></a>
7
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#find" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>find</span></a>
8
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#findbyid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>find<wbr/>By<wbr/>Id</span></a>
9
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#foreach" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>for<wbr/>Each</span></a>
10
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#map" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>map</span></a>
11
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#push" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>push</span></a>
12
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#refresh" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a>
13
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#remove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove</span></a>
14
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#removeall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>All</span></a>
15
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#removebyid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>By<wbr/>Id</span></a>
16
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#setdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a>
17
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#some" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>some</span></a>
18
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#toarray" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Array</span></a>
19
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#tocollection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Collection</span></a>
20
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#upsert" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upsert</span></a>
21
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#ids" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ids</span></a>
22
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#isempty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Empty</span></a>
23
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#items" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>items</span></a>
24
+ <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#lastidx" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>last<wbr/>Idx</span></a>
25
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorcollectionadapter" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">CollectionAdapter</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">_collection$</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_dispose</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructorcollectionadapter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructor for creating an instance of the class.</p>
26
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorcollectionadaptert" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_collection$</span>: <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The mutable reference object for the collection.</p>
27
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">_dispose</span>: <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The subject used for disposing.</p>
28
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_hooks_useCollection.CollectionAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6508">types.d.ts:6508</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="clear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear</span><a href="#clear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clear</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Clears the collection.</p>
29
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async" class="tsd-anchor"></a>Async<a href="#async" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#clear">clear</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6557">types.d.ts:6557</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="filter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>filter</span><a href="#filter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Filters the items in the collection based on the provided function.</p>
30
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>A function used to filter the collection items.
31
+ The function should accept two parameters: value and idx.</p>
32
+ <ul>
33
+ <li>value: The current item being processed in the collection.</li>
34
+ <li>idx: The index of the current item being processed in the collection.</li>
35
+ </ul>
36
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h4><ul>
37
+ <li>An array containing the filtered items from the collection.</li>
38
+ </ul>
39
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#filter">filter</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6647">types.d.ts:6647</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find</span><a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">find</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Finds the first element in the collection that satisfies the given condition.</p>
40
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The condition to be satisfied.</p>
41
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
42
+ <li>The first element that satisfies the condition, or undefined if no element satisfies the condition.</li>
43
+ </ul>
44
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#find">find</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6634">types.d.ts:6634</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="findbyid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>By<wbr/>Id</span><a href="#findbyid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">findById</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Finds an entity by its ID in the current collection.</p>
45
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The ID of the entity to be found.</p>
46
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
47
+ <li>An instance of CollectionEntityAdapter representing the found entity.</li>
48
+ </ul>
49
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#findbyid">findById</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6604">types.d.ts:6604</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="foreach" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>for<wbr/>Each</span><a href="#foreach" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">forEach</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Performs a given function on each element of the collection.</p>
50
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>The function to be executed on each element.
51
+ The function should take two parameters: the current value in the collection
52
+ and the index of the current value.</p>
53
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#foreach">forEach</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6625">types.d.ts:6625</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="map" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>map</span><a href="#map" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Maps over the items in the collection and returns an array of values.</p>
54
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a class="tsd-anchor"></a><span class="tsd-kind-type-parameter">V</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">unknown</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the mapped values.</p>
55
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a></span><div class="tsd-comment tsd-typography"><p>The mapping function.</p>
56
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="">V</a><span class="tsd-signature-symbol">[]</span></h4><ul>
57
+ <li>An array of values obtained by applying the mapping function to each item.</li>
58
+ </ul>
59
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#map">map</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6657">types.d.ts:6657</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="push" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>push</span><a href="#push" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">push</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Asynchronously pushes item(s) to the collection.</p>
60
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The item(s) to push.</p>
61
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves once the item(s) are pushed to the collection.</p>
62
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#push">push</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6564">types.d.ts:6564</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="refresh" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh</span><a href="#refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">refresh</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Refreshes the current collection after waiting for listeners.</p>
63
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves after the collection is refreshed.</p>
64
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async-1" class="tsd-anchor"></a>Async<a href="#async-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-1" class="tsd-anchor"></a>Function<a href="#function-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#refresh">refresh</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6550">types.d.ts:6550</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="remove" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove</span><a href="#remove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">remove</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Removes an entity from the collection.</p>
65
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entity</span>: <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a></span><div class="tsd-comment tsd-typography"><p>The entity to be removed from the collection.</p>
66
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
67
+ <li>A Promise that resolves when the entity is successfully removed.</li>
68
+ </ul>
69
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#remove">remove</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6579">types.d.ts:6579</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="removeall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>All</span><a href="#removeall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">removeAll</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Removes all items from the collection.</p>
70
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves once all items are removed.</p>
71
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async-2" class="tsd-anchor"></a>Async<a href="#async-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-2" class="tsd-anchor"></a>Function<a href="#function-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>removeAll</p>
72
+ </div><div class="tsd-tag-instance"><h4 class="tsd-anchor-link"><a id="instance" class="tsd-anchor"></a>Instance<a href="#instance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#removeall">removeAll</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6597">types.d.ts:6597</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="removebyid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>By<wbr/>Id</span><a href="#removebyid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">removeById</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Removes an item from the collection by its ID.</p>
73
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The ID of the item to remove.</p>
74
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with no value.</p>
75
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async-3" class="tsd-anchor"></a>Async<a href="#async-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#removebyid">removeById</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6587">types.d.ts:6587</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Data</span><a href="#setdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Sets new data for the collection.</p>
76
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">items</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The new collection data.</p>
77
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
78
+ <li>A promise that resolves when the new data is set.</li>
79
+ </ul>
80
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#setdata">setData</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6542">types.d.ts:6542</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="some" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>some</span><a href="#some" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">some</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Checks if any element of the collection satisfies the provided testing function.</p>
81
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The testing function to apply to each element of the collection.
82
+ It should take two arguments: the current element of the collection
83
+ and its index. Returns a boolean value indicating whether the element
84
+ satisfies the testing condition.</p>
85
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><ul>
86
+ <li>A boolean value indicating whether any element of the collection satisfies
87
+ the testing function.</li>
88
+ </ul>
89
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#some">some</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6615">types.d.ts:6615</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toarray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Array</span><a href="#toarray" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toArray</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Retrieves an array representation of the current collection.</p>
90
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span></h4><ul>
91
+ <li>An array representation of the current collection.</li>
92
+ </ul>
93
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#toarray">toArray</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6665">types.d.ts:6665</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tocollection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Collection</span><a href="#tocollection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toCollection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Retrieve the current value of the collection.</p>
94
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The current value of the collection.</p>
95
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6671">types.d.ts:6671</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="upsert" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>upsert</span><a href="#upsert" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">upsert</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Upserts one or more items into the current collection.</p>
96
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>One or more items to upsert into the collection.</p>
97
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
98
+ <li>A Promise that resolves when the upsert operation is complete.</li>
99
+ </ul>
100
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#upsert">upsert</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6572">types.d.ts:6572</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="ids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ids</span><a href="#ids" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="ids-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">ids</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span>)<span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the IDs from the current collection.</p>
101
+ </div><h4 class="tsd-returns-title">Returns (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span>)<span class="tsd-signature-symbol">[]</span></h4><p>The IDs from the current collection.</p>
102
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#ids">ids</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6517">types.d.ts:6517</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="isempty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Empty</span><a href="#isempty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="isempty-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isEmpty</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if the collection is empty.</p>
103
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><ul>
104
+ <li>True if the collection is empty, otherwise false.</li>
105
+ </ul>
106
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-3" class="tsd-anchor"></a>Function<a href="#function-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#isempty">isEmpty</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6535">types.d.ts:6535</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="items" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>items</span><a href="#items" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="items-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">items</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve the items from the current collection.</p>
107
+ </div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionAdapter.html#constructorcollectionadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h4><p>An array of CollectionEntityAdapter instances.</p>
108
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#items">items</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6528">types.d.ts:6528</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="lastidx" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last<wbr/>Idx</span><a href="#lastidx" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="lastidx-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">lastIdx</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the last index from the current collection.</p>
109
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The last index of the current collection.</p>
110
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html">ICollectionAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Collection.ICollectionAdapter.html#lastidx">lastIdx</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6522">types.d.ts:6522</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#clear" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear</span></a><a href="#filter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter</span></a><a href="#find" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>find</span></a><a href="#findbyid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>find<wbr/>By<wbr/>Id</span></a><a href="#foreach" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>for<wbr/>Each</span></a><a href="#map" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>map</span></a><a href="#push" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>push</span></a><a href="#refresh" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a><a href="#remove" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove</span></a><a href="#removeall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>All</span></a><a href="#removebyid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>By<wbr/>Id</span></a><a href="#setdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a><a href="#some" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>some</span></a><a href="#toarray" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Array</span></a><a href="#tocollection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Collection</span></a><a href="#upsert" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upsert</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#ids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ids</span></a><a href="#isempty" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Empty</span></a><a href="#items" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>items</span></a><a href="#lastidx" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>last<wbr/>Idx</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CollectionEntityAdapter | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_hooks_useCollection.html">react-declarative/hooks/useCollection</a></li><li><a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html">CollectionEntityAdapter</a></li></ul><h1>Class CollectionEntityAdapter&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing a Collection Entity Adapter.</p>
2
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-implements"><h4 class="tsd-anchor-link"><a id="implements" class="tsd-anchor"></a>Implements<a href="#implements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html" class="tsd-signature-type tsd-kind-interface">IEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6446">types.d.ts:6446</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
4
+ <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#refresh" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a>
5
+ <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#setdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a>
6
+ <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#toentity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Entity</span></a>
7
+ <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#toobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a>
8
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorcollectionentityadapter" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">CollectionEntityAdapter</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_collection$</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_dispose</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructorcollectionentityadapter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorcollectionentityadaptert" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">_collection$</span>: <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Collection.html" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><span class="tsd-kind-parameter">_dispose</span>: <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html" class="tsd-signature-type tsd-kind-class">CollectionEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6450">types.d.ts:6450</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>An identifier representing the unique identity of an entity.</p>
10
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6449">types.d.ts:6449</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="refresh" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh</span><a href="#refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">refresh</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Refreshes the entity asynchronously.</p>
11
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves once the entity is refreshed.</p>
12
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If an error occurs while refreshing the entity.</p>
13
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#refresh">refresh</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6474">types.d.ts:6474</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Data</span><a href="#setdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Sets the data for the entity.</p>
14
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to set. It can be either a partial object of type T or a function that takes the previous data of type T and returns
15
+ a partial object of type T.</p>
16
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
17
+ <li>A promise that resolves when the data is set.</li>
18
+ </ul>
19
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async" class="tsd-anchor"></a>Async<a href="#async" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-1" class="tsd-anchor"></a>Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
20
+ <li>If the entity (with the given ID) is not found in the collection.</li>
21
+ </ul>
22
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#setdata">setData</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6465">types.d.ts:6465</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toentity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Entity</span><a href="#toentity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toEntity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the entity with the specified ID from the current collection.</p>
23
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The entity with the specified ID.</p>
24
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-2" class="tsd-anchor"></a>Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the entity is not found in the collection.</p>
25
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6492">types.d.ts:6492</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toobject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a></div><div class="tsd-comment tsd-typography"><p>Converts the current object to a plain JavaScript object.</p>
26
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a></h4><p>A plain JavaScript object representing the current entity.</p>
27
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-memberOf"><h4 class="tsd-anchor-link"><a id="member-of" class="tsd-anchor"></a>Member Of<a href="#member-of" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[variable name]</p>
28
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-3" class="tsd-anchor"></a>Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the entity is not found in the collection.</p>
29
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#toobject">toObject</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6484">types.d.ts:6484</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="data-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">data</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Represents a variable of type T.</p>
30
+ </div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useCollection.CollectionEntityAdapter.html#constructorcollectionentityadaptert">T</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-typeparam"><h4 class="tsd-anchor-link"><a id="typeparam" class="tsd-anchor"></a>Typeparam<a href="#typeparam" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>T - The type of data stored in the variable.</p>
31
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6455">types.d.ts:6455</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#refresh" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a><a href="#setdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a><a href="#toentity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Entity</span></a><a href="#toobject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_hooks_useEntity.EntityAdapter.html ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EntityAdapter | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_hooks_useEntity.html">react-declarative/hooks/useEntity</a></li><li><a href="types.react-declarative_hooks_useEntity.EntityAdapter.html">EntityAdapter</a></li></ul><h1>Class EntityAdapter&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing an Entity Adapter.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the entity.</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html" class="tsd-signature-type tsd-kind-interface">IEntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6225">types.d.ts:6225</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useEntity.EntityAdapter.html#refresh" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a>
5
+ <a href="types.react-declarative_hooks_useEntity.EntityAdapter.html#setdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a>
6
+ <a href="types.react-declarative_hooks_useEntity.EntityAdapter.html#toentity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Entity</span></a>
7
+ <a href="types.react-declarative_hooks_useEntity.EntityAdapter.html#toobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a>
8
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useEntity.EntityAdapter.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a>
9
+ <a href="types.react-declarative_hooks_useEntity.EntityAdapter.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a>
10
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorentityadapter" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">EntityAdapter</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">_entity$</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_dispose</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useEntity.EntityAdapter.html" class="tsd-signature-type tsd-kind-class">EntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructorentityadapter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Represents a Constructor.</p>
11
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorentityadaptert" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntity.html" class="tsd-signature-type tsd-kind-interface">IEntity</a> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_entity$</span>: <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The _entity$ parameter.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">_dispose</span>: <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The _dispose parameter.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_hooks_useEntity.EntityAdapter.html" class="tsd-signature-type tsd-kind-class">EntityAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6235">types.d.ts:6235</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="refresh" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh</span><a href="#refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">refresh</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Refreshes the entity data.</p>
14
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-async"><h4 class="tsd-anchor-link"><a id="async" class="tsd-anchor"></a>Async<a href="#async" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>refresh</p>
15
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#refresh">refresh</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6267">types.d.ts:6267</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Data</span><a href="#setdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Sets the data for the object.</p>
16
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to set.
17
+ Can be either a partial object of type T or a function that takes the previous data of type T and returns a partial object of type T.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
19
+ <li>A Promise that resolves after the data is set.</li>
20
+ </ul>
21
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#setdata">setData</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6258">types.d.ts:6258</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toentity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Entity</span><a href="#toentity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toEntity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the current entity object.</p>
22
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Entity.html" class="tsd-signature-type tsd-kind-class">Entity</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The current entity object.</p>
23
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6280">types.d.ts:6280</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toobject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a></div><div class="tsd-comment tsd-typography"><p>Converts the current value of the <code>_entity$</code> property to an object.</p>
24
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a></h4><p>The <code>_entity$</code> property value converted to an object.</p>
25
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function-1" class="tsd-anchor"></a>Function<a href="#function-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>toObject</p>
26
+ </div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#toobject">toObject</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6274">types.d.ts:6274</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="data-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">data</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the data associated with the current entity.</p>
27
+ </div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useEntity.EntityAdapter.html#constructorentityadaptert">T</a></h4><p>The data object.</p>
28
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6244">types.d.ts:6244</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="id-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">id</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve the ID of the current entity.</p>
29
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></h4><p>The ID of the current entity.</p>
30
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html">IEntityAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Entity.IEntityAdapter.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6250">types.d.ts:6250</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#refresh" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a><a href="#setdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a><a href="#toentity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Entity</span></a><a href="#toobject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_hooks_useModel.ModelAdapter.html ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ModelAdapter | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_hooks_useModel.html">react-declarative/hooks/useModel</a></li><li><a href="types.react-declarative_hooks_useModel.ModelAdapter.html">ModelAdapter</a></li></ul><h1>Class ModelAdapter&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ModelAdapter class that implements the IModelAdapter interface.
2
+ It adapts a React.MutableRefObject&lt;Model<T>&gt; and provides methods to interact with the underlying model.</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">{}</span> = <span class="tsd-signature-type">any</span></span></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html" class="tsd-signature-type tsd-kind-interface">IModelAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6144">types.d.ts:6144</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useModel.ModelAdapter.html#refresh" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a>
5
+ <a href="types.react-declarative_hooks_useModel.ModelAdapter.html#setdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a>
6
+ <a href="types.react-declarative_hooks_useModel.ModelAdapter.html#tomodel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Model</span></a>
7
+ <a href="types.react-declarative_hooks_useModel.ModelAdapter.html#toobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a>
8
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative_hooks_useModel.ModelAdapter.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructormodeladapter" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ModelAdapter</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-symbol">{}</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">_model$</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">_dispose</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_hooks_useModel.ModelAdapter.html" class="tsd-signature-type tsd-kind-class">ModelAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructormodeladapter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructormodeladaptert" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">{}</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_model$</span>: <span class="tsd-signature-type">MutableRefObject</span><span class="tsd-signature-symbol">&lt;</span><a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><span class="tsd-kind-parameter">_dispose</span>: <a href="types.react-declarative.Subject.html" class="tsd-signature-type tsd-kind-class">Subject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_hooks_useModel.ModelAdapter.html" class="tsd-signature-type tsd-kind-class">ModelAdapter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6145">types.d.ts:6145</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="refresh" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh</span><a href="#refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">refresh</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Asynchronously refreshes the current model.</p>
10
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves when the model has been refreshed.</p>
11
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#refresh">refresh</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6170">types.d.ts:6170</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Data</span><a href="#setdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Sets the data of the variable.</p>
12
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to set. It can be a partial object of type T or a function that accepts the previous data and returns a partial
13
+ object of type T.</p>
14
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
15
+ <li>A promise that resolves when the data is set.</li>
16
+ </ul>
17
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#setdata">setData</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6162">types.d.ts:6162</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tomodel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Model</span><a href="#tomodel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toModel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the current state of the model.</p>
18
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="types.react-declarative.Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The current state of the model.</p>
19
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6184">types.d.ts:6184</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toobject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a></div><div class="tsd-comment tsd-typography"><p>Converts the current state of the object to a plain JavaScript object.</p>
20
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a></h4><p>The object converted to a plain JavaScript object.</p>
21
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-function"><h4 class="tsd-anchor-link"><a id="function" class="tsd-anchor"></a>Function<a href="#function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>toObject</p>
22
+ </div><div class="tsd-tag-instance"><h4 class="tsd-anchor-link"><a id="instance" class="tsd-anchor"></a>Instance<a href="#instance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#toobject">toObject</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6178">types.d.ts:6178</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="data-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">data</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the current data value from the model.</p>
23
+ </div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="types.react-declarative_hooks_useModel.ModelAdapter.html#constructormodeladaptert">T</a></h4><p>The current data value.</p>
24
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html">IModelAdapter</a>.<a href="../interfaces/types.react-declarative_utils_mvvm_Model.IModelAdapter.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L6154">types.d.ts:6154</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#refresh" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh</span></a><a href="#setdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Data</span></a><a href="#tomodel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Model</span></a><a href="#toobject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Object</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_utils_datetime.Date.html ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Date | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_utils_datetime.html">react-declarative/utils/datetime</a></li><li><a href="types.react-declarative_utils_datetime.Date.html">Date</a></li></ul><h1>Class Date</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a date.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10890">types.d.ts:10890</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_utils_datetime.Date.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative_utils_datetime.Date.html#day" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>day</span></a>
4
+ <a href="types.react-declarative_utils_datetime.Date.html#fromstamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from<wbr/>Stamp</span></a>
5
+ <a href="types.react-declarative_utils_datetime.Date.html#month" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>month</span></a>
6
+ <a href="types.react-declarative_utils_datetime.Date.html#tostamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Stamp</span></a>
7
+ <a href="types.react-declarative_utils_datetime.Date.html#tostring" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>String</span></a>
8
+ <a href="types.react-declarative_utils_datetime.Date.html#year" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>year</span></a>
9
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative_utils_datetime.Date.html#isvalid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Valid</span></a>
10
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructordate" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Date</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_utils_datetime.Date.html" class="tsd-signature-type tsd-kind-class">Date</a><a href="#constructordate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_utils_datetime.Date.html" class="tsd-signature-type tsd-kind-class">Date</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10898">types.d.ts:10898</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="day" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>day</span><a href="#day" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10891">types.d.ts:10891</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fromstamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>from<wbr/>Stamp</span><a href="#fromstamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fromStamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_utils_datetime.Date.html" class="tsd-signature-type tsd-kind-class">Date</a></div><div class="tsd-comment tsd-typography"><p>Converts a stamp value to a date object.</p>
11
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_utils_datetime.Date.html" class="tsd-signature-type tsd-kind-class">Date</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">stamp</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The number of days since '1970-01-01' to convert.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_utils_datetime.Date.html" class="tsd-signature-type tsd-kind-class">Date</a></h4><ul>
13
+ <li>The converted date object.</li>
14
+ </ul>
15
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10917">types.d.ts:10917</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="month" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>month</span><a href="#month" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10892">types.d.ts:10892</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tostamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Stamp</span><a href="#tostamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toStamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Calculates the number of days from 1970-01-01 to a specified date.</p>
16
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The number of days from 1970-01-01 to the specified date.</p>
17
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10910">types.d.ts:10910</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tostring" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toString</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Returns a string representation of the current object.</p>
18
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><p>The serialized string representation of the object.</p>
19
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10904">types.d.ts:10904</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="year" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>year</span><a href="#year" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10893">types.d.ts:10893</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="isvalid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Valid</span><a href="#isvalid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="isvalid-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isValid</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if date is valid</p>
20
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10897">types.d.ts:10897</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#day" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>day</span></a><a href="#fromstamp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from<wbr/>Stamp</span></a><a href="#month" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>month</span></a><a href="#tostamp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Stamp</span></a><a href="#tostring" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>String</span></a><a href="#year" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>year</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#isvalid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Valid</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
classes/types.react-declarative_utils_datetime.Time.html ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Time | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="../modules/types.html">types</a></li><li><a href="../modules/types.react-declarative_utils_datetime.html">react-declarative/utils/datetime</a></li><li><a href="types.react-declarative_utils_datetime.Time.html">Time</a></li></ul><h1>Class Time</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a specific point in time.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10859">types.d.ts:10859</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.react-declarative_utils_datetime.Time.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.react-declarative_utils_datetime.Time.html#fromstamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from<wbr/>Stamp</span></a>
4
+ <a href="types.react-declarative_utils_datetime.Time.html#hour" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hour</span></a>
5
+ <a href="types.react-declarative_utils_datetime.Time.html#minute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>minute</span></a>
6
+ <a href="types.react-declarative_utils_datetime.Time.html#tostamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Stamp</span></a>
7
+ <a href="types.react-declarative_utils_datetime.Time.html#tostring" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>String</span></a>
8
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="types.react-declarative_utils_datetime.Time.html#isvalid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Valid</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructortime" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Time</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.react-declarative_utils_datetime.Time.html" class="tsd-signature-type tsd-kind-class">Time</a><a href="#constructortime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.react-declarative_utils_datetime.Time.html" class="tsd-signature-type tsd-kind-class">Time</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10866">types.d.ts:10866</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="fromstamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>from<wbr/>Stamp</span><a href="#fromstamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fromStamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_utils_datetime.Time.html" class="tsd-signature-type tsd-kind-class">Time</a></div><div class="tsd-comment tsd-typography"><p>Takes a stamp value and converts it into a Time object.</p>
10
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_utils_datetime.Time.html" class="tsd-signature-type tsd-kind-class">Time</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">stamp</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The stamp value representing minutes since 1970-01-01 00:00.</p>
11
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="types.react-declarative_utils_datetime.Time.html" class="tsd-signature-type tsd-kind-class">Time</a></h4><ul>
12
+ <li>The Time object representing the hour and minute derived from the stamp value.</li>
13
+ </ul>
14
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10885">types.d.ts:10885</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hour" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>hour</span><a href="#hour" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10860">types.d.ts:10860</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="minute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>minute</span><a href="#minute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10861">types.d.ts:10861</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tostamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Stamp</span><a href="#tostamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toStamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Calculates the total minutes represented by the hour and minute properties of an object.</p>
15
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The total minutes represented by the hour and minute properties.</p>
16
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10878">types.d.ts:10878</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tostring" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toString</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Converts the object to a string representation.</p>
17
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><p>The string representation of the object.</p>
18
+ <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10872">types.d.ts:10872</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="isvalid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Valid</span><a href="#isvalid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="isvalid-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isValid</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if time is valid</p>
19
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react-declarative/react-declarative-docs/blob/3504bbea2218431d30a1a450c7daeb7d5bd7f0db/types.d.ts#L10865">types.d.ts:10865</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#fromstamp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from<wbr/>Stamp</span></a><a href="#hour" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hour</span></a><a href="#minute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>minute</span></a><a href="#tostamp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Stamp</span></a><a href="#tostring" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>String</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#isvalid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Valid</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
documents/docs_advanced_ai-integration.html ADDED
@@ -0,0 +1,99 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>docs/advanced/ai-integration | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="docs_advanced_ai-integration.html">docs/advanced/ai-integration</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="generating-ui-with-ai-using-json-schemas" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Generating UI with AI using JSON schemas<a href="#generating-ui-with-ai-using-json-schemas" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>react-declarative</code> is exceptionally well-suited for AI-assisted UI generation. The form schema is a plain JSON array of field objects—no JSX, no hooks, no state management code. Because <code>&lt;One /&gt;</code> handles all state automatically, you never need to ask an AI to write <code>useState</code>, <code>useEffect</code>, or event handlers. You give the model a working example, describe what you want, and paste the output directly into the playground to verify it before using it in your app.</p>
2
+ <a id="try-it-in-the-playground-first" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Try it in the playground first<a href="#try-it-in-the-playground-first" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Before writing any code, try generating schemas at <a href="https://react-declarative-playground.github.io/">react-declarative-playground.github.io</a>. The playground runs entirely in the browser—paste a schema and see the rendered form immediately.</p>
3
+ <blockquote>
4
+ <p><strong>Tip:</strong> The playground accepts the raw <code>fields</code> array. You do not need a full React component—just the JSON.</p>
5
+ </blockquote>
6
+ <a id="why-llms-work-well-with-this-format" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Why LLMs work well with this format<a href="#why-llms-work-well-with-this-format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <code>IField</code> / <code>TypedField</code> schema has properties that are self-describing:</p>
7
+ <ul>
8
+ <li><code>type</code> is a string enum (<code>FieldType.Text</code>, <code>FieldType.Combo</code>, etc.)—easy to enumerate in a prompt</li>
9
+ <li><code>name</code> maps directly to a data field name—no wiring needed</li>
10
+ <li><code>isVisible</code>, <code>isDisabled</code>, <code>isInvalid</code> are plain functions—LLMs write them naturally</li>
11
+ <li>Layout is expressed as <code>columns</code> strings (<code>&quot;6&quot;</code> = half-width)—no CSS to invent</li>
12
+ <li>Validation lives inside the schema, not in a separate schema file</li>
13
+ </ul>
14
+ <p>Because state management is automatic, the AI never needs to generate any React state code. The complete output is just a <code>TypedField[]</code> array.</p>
15
+ <a id="the-prompt-workflow" class="tsd-anchor"></a><h2 class="tsd-anchor-link">The prompt workflow<a href="#the-prompt-workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Step 1: Choose a reference sample</strong></p>
16
+ <p>Pick a sample schema from the list below that most closely resembles what you want to build. Copy the entire code block including the <code>import</code> line.</p>
17
+ <p><strong>Step 2: Open your preferred AI tool</strong></p>
18
+ <p>Any major LLM works. ChatGPT, Claude, Gemini, Copilot, and Perplexity all have enough knowledge of <code>react-declarative</code> to generate valid schemas.</p>
19
+ <p><strong>Step 3: Send the reference + your description</strong></p>
20
+ <p>Paste the sample code into the chat and add your request. A reliable prompt pattern:</p>
21
+ <pre><code class="text">Read the code below and generate a new form schema in the same format.
22
+ The form should collect: [describe your fields here].
23
+
24
+ [paste the sample code]
25
+ </code><button type="button">Copy</button></pre>
26
+
27
+ <p><strong>Step 4: Verify in the playground</strong></p>
28
+ <p>Copy the generated <code>fields</code> array to <a href="https://react-declarative-playground.github.io/">react-declarative-playground.github.io</a> and check the rendered output. Fix any issues by asking the AI to adjust.</p>
29
+ <p><strong>Step 5: Drop it into your app</strong></p>
30
+ <p>Once it looks right, import the fields array and pass it to <code>&lt;One /&gt;</code>.</p>
31
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">One</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">fields</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./generatedFields&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">MyPage</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">One</span><br/><span class="hl-1"> </span><span class="hl-8">fields</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">fields</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">handler</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-9">() </span><span class="hl-4">=&gt;</span><span class="hl-9"> ({})</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">onChange</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-9">(</span><span class="hl-2">data</span><span class="hl-9">) </span><span class="hl-4">=&gt;</span><span class="hl-9"> </span><span class="hl-2">console</span><span class="hl-9">.</span><span class="hl-5">log</span><span class="hl-9">(</span><span class="hl-2">data</span><span class="hl-9">)</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1">);</span>
32
+ </code><button type="button">Copy</button></pre>
33
+
34
+ <a id="reference-samples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Reference samples<a href="#reference-samples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>These samples exist specifically as AI training material. Each one demonstrates a different combination of field types, layouts, and validation patterns.</p>
35
+ <a id="order_info--multi-section-form-with-date-and-combo-fields" class="tsd-anchor"></a><h3 class="tsd-anchor-link">order_info — multi-section form with date and combo fields<a href="#order_info--multi-section-form-with-date-and-combo-fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A three-section form covering general information, passport details, and profile metadata. Demonstrates <code>FieldType.Paper</code> grouping, responsive column layout, and <code>FieldType.Date</code> / <code>FieldType.Combo</code> usage.</p>
36
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/order_info.md">docs/sample/order_info.md</a></p>
37
+ <a id="login_form--centered-card-with-action-feedback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">login_form — centered card with action feedback<a href="#login_form--centered-card-with-action-feedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A sign-in form centered in the viewport using <code>FieldType.Box</code> and <code>FieldType.Paper</code>, with a <code>Subject</code>-driven loading state on the submit icon. Good reference for action-button patterns.</p>
38
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/login_form.md">docs/sample/login_form.md</a></p>
39
+ <a id="profile_card--avatar-layout-with-nested-groups" class="tsd-anchor"></a><h3 class="tsd-anchor-link">profile_card — avatar layout with nested groups<a href="#profile_card--avatar-layout-with-nested-groups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A profile page with a CSS-grid avatar section, inline conditional fields, <code>FieldType.Expansion</code> for collapsible areas, and email validation. Demonstrates <code>FieldType.Component</code> for embedding arbitrary JSX.</p>
40
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/profile_card.md">docs/sample/profile_card.md</a></p>
41
+ <a id="settings_page--grouped-settings-with-switches-and-sliders" class="tsd-anchor"></a><h3 class="tsd-anchor-link">settings_page — grouped settings with switches and sliders<a href="#settings_page--grouped-settings-with-switches-and-sliders" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A settings page using <code>FieldType.Switch</code>, <code>FieldType.Slider</code>, <code>FieldType.Rating</code>, and <code>FieldType.Progress</code>. Good for AI to learn the full range of input types.</p>
42
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/settings_page.md">docs/sample/settings_page.md</a></p>
43
+ <a id="gallery_of_controls--one-of-every-field-type" class="tsd-anchor"></a><h3 class="tsd-anchor-link">gallery_of_controls — one of every field type<a href="#gallery_of_controls--one-of-every-field-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Every available <code>FieldType</code> in a single form. Use this sample when you want the AI to know the complete vocabulary of available field types.</p>
44
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/gallery_of_controls.md">docs/sample/gallery_of_controls.md</a></p>
45
+ <a id="typography--display-only-content-layouts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">typography — display-only content layouts<a href="#typography--display-only-content-layouts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Forms that combine <code>FieldType.Typography</code>, <code>FieldType.Line</code>, and <code>FieldType.Rating</code> to create read-only display panels. Good for dashboards and detail views.</p>
46
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/typography.md">docs/sample/typography.md</a></p>
47
+ <a id="product_shape--e-commerce-product-form" class="tsd-anchor"></a><h3 class="tsd-anchor-link">product_shape — e-commerce product form<a href="#product_shape--e-commerce-product-form" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A product entry form with price, SKU, category combo, stock toggle, and image URL. Demonstrates mixed outlined and standard field variants.</p>
48
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/product_shape.md">docs/sample/product_shape.md</a></p>
49
+ <a id="variant_form--conditional-field-visibility" class="tsd-anchor"></a><h3 class="tsd-anchor-link">variant_form — conditional field visibility<a href="#variant_form--conditional-field-visibility" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A form where fields appear and disappear based on other field values using <code>isVisible</code>. The best sample for showing the AI how conditional logic works.</p>
50
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/variant_form.md">docs/sample/variant_form.md</a></p>
51
+ <a id="adaptive_form--responsive-multi-column-layout" class="tsd-anchor"></a><h3 class="tsd-anchor-link">adaptive_form — responsive multi-column layout<a href="#adaptive_form--responsive-multi-column-layout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A form that uses <code>desktopColumns</code>, <code>tabletColumns</code>, and <code>phoneColumns</code> on every field. Use this when you need the AI to generate a layout that works on multiple screen sizes.</p>
52
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/adaptive_form.md">docs/sample/adaptive_form.md</a></p>
53
+ <a id="dashboard--kpi-cards-and-data-display" class="tsd-anchor"></a><h3 class="tsd-anchor-link">dashboard — KPI cards and data display<a href="#dashboard--kpi-cards-and-data-display" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A read-only dashboard layout using nested <code>FieldType.Paper</code> and <code>FieldType.Group</code> containers with <code>FieldType.Component</code> cells. Good for report-style UIs.</p>
54
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/dashboard.md">docs/sample/dashboard.md</a></p>
55
+ <a id="account_info--account-management-form" class="tsd-anchor"></a><h3 class="tsd-anchor-link">account_info — account management form<a href="#account_info--account-management-form" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>A full account settings page with personal details, password change, and notification preferences sections.</p>
56
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/account_info.md">docs/sample/account_info.md</a></p>
57
+ <a id="custom_jsx--arbitrary-jsx-inside-a-form" class="tsd-anchor"></a><h3 class="tsd-anchor-link">custom_jsx — arbitrary JSX inside a form<a href="#custom_jsx--arbitrary-jsx-inside-a-form" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Demonstrates <code>FieldType.Component</code> and <code>FieldType.Layout</code> for embedding completely custom React components inside a <code>&lt;One /&gt;</code> form without breaking the state model.</p>
58
+ <p>See <a href="https://github.com/react-declarative/react-declarative/blob/master/docs/sample/custom_jsx.md">docs/sample/custom_jsx.md</a></p>
59
+ <a id="example-generating-a-registration-form" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Example: generating a registration form<a href="#example-generating-a-registration-form" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Here is a concrete prompt and the kind of output it produces.</p>
60
+ <p><strong>Prompt:</strong></p>
61
+ <pre><code class="text">Read the code below and generate a new form schema in the same format.
62
+
63
+ The form should collect user registration data:
64
+ - First name and last name (side by side, required)
65
+ - Email address (with validation)
66
+ - Password and confirm password (with match validation)
67
+ - Date of birth
68
+ - Country (dropdown: USA, UK, Canada, Australia)
69
+ - Terms accepted (checkbox, required)
70
+
71
+ Use FieldType.Paper to group related fields.
72
+ Show validation errors only after the field has been touched.
73
+
74
+ [paste the order_info.md code here]
75
+ </code><button type="button">Copy</button></pre>
76
+
77
+ <p><strong>Generated output:</strong></p>
78
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">TypedField</span><span class="hl-1">, </span><span class="hl-2">FieldType</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">fields</span><span class="hl-1">: </span><span class="hl-7">TypedField</span><span class="hl-1">[] = [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Paper</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">fieldBottomMargin:</span><span class="hl-1"> </span><span class="hl-3">&quot;1&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">fields:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Typography</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">typoVariant:</span><span class="hl-1"> </span><span class="hl-3">&quot;h6&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">placeholder:</span><span class="hl-1"> </span><span class="hl-3">&quot;Personal Information&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">desktopColumns:</span><span class="hl-1"> </span><span class="hl-3">&quot;6&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">tabletColumns:</span><span class="hl-1"> </span><span class="hl-3">&quot;6&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">phoneColumns:</span><span class="hl-1"> </span><span class="hl-3">&quot;12&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">outlined:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;firstName&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;First Name&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">firstName</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> !</span><span class="hl-2">firstName</span><span class="hl-1"> ? </span><span class="hl-3">&quot;First name is required&quot;</span><span class="hl-1"> : </span><span class="hl-4">null</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">desktopColumns:</span><span class="hl-1"> </span><span class="hl-3">&quot;6&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">tabletColumns:</span><span class="hl-1"> </span><span class="hl-3">&quot;6&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">phoneColumns:</span><span class="hl-1"> </span><span class="hl-3">&quot;12&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">outlined:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;lastName&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;Last Name&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">lastName</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> !</span><span class="hl-2">lastName</span><span class="hl-1"> ? </span><span class="hl-3">&quot;Last name is required&quot;</span><span class="hl-1"> : </span><span class="hl-4">null</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">outlined:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;email&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;Email Address&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">email</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">re</span><span class="hl-1"> =</span><span class="hl-11"> /</span><span class="hl-12">^</span><span class="hl-13">[</span><span class="hl-14">\w</span><span class="hl-11">-.</span><span class="hl-13">]</span><span class="hl-15">+</span><span class="hl-11">@</span><span class="hl-13">([</span><span class="hl-11">\w-</span><span class="hl-13">]</span><span class="hl-15">+</span><span class="hl-14">\.</span><span class="hl-13">)</span><span class="hl-15">+</span><span class="hl-13">[</span><span class="hl-11">\w-</span><span class="hl-13">]</span><span class="hl-15">{2,4}</span><span class="hl-12">$</span><span class="hl-11">/</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">re</span><span class="hl-1">.</span><span class="hl-5">test</span><span class="hl-1">(</span><span class="hl-2">email</span><span class="hl-1">) ? </span><span class="hl-4">null</span><span class="hl-1"> : </span><span class="hl-3">&quot;Enter a valid email address&quot;</span><span class="hl-1">;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Date</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">outlined:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;dateOfBirth&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;Date of Birth&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Combo</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">outlined:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;country&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;Country&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">itemList:</span><span class="hl-1"> [</span><span class="hl-3">&quot;USA&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;UK&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;Canada&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;Australia&quot;</span><span class="hl-1">],</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Paper</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">fieldBottomMargin:</span><span class="hl-1"> </span><span class="hl-3">&quot;1&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">fields:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Typography</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">typoVariant:</span><span class="hl-1"> </span><span class="hl-3">&quot;h6&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">placeholder:</span><span class="hl-1"> </span><span class="hl-3">&quot;Password&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">outlined:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;password&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;Password&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">inputType:</span><span class="hl-1"> </span><span class="hl-3">&quot;password&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">password</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-2">password</span><span class="hl-1"> &amp;&amp; </span><span class="hl-2">password</span><span class="hl-1">.</span><span class="hl-2">length</span><span class="hl-1"> &gt;= </span><span class="hl-16">8</span><br/><span class="hl-1"> ? </span><span class="hl-4">null</span><br/><span class="hl-1"> : </span><span class="hl-3">&quot;Password must be at least 8 characters&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">outlined:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;confirmPassword&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;Confirm Password&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">inputType:</span><span class="hl-1"> </span><span class="hl-3">&quot;password&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">password</span><span class="hl-1">, </span><span class="hl-2">confirmPassword</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-2">password</span><span class="hl-1"> === </span><span class="hl-2">confirmPassword</span><span class="hl-1"> ? </span><span class="hl-4">null</span><span class="hl-1"> : </span><span class="hl-3">&quot;Passwords do not match&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">CheckBox</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;termsAccepted&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;I accept the terms and conditions&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">termsAccepted</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-2">termsAccepted</span><span class="hl-1"> ? </span><span class="hl-4">null</span><span class="hl-1"> : </span><span class="hl-3">&quot;You must accept the terms&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">];</span>
79
+ </code><button type="button">Copy</button></pre>
80
+
81
+ <blockquote>
82
+ <p><strong>Note:</strong> The AI does not need to write any <code>useState</code>, <code>useEffect</code>, or form submission logic. <code>&lt;One /&gt;</code> manages state automatically. You only add an <code>onChange</code> handler to collect the final data object.</p>
83
+ </blockquote>
84
+ <a id="tips-for-better-ai-output" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Tips for better AI output<a href="#tips-for-better-ai-output" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Include the import line in your sample</strong></p>
85
+ <p>LLMs use the import statement to confirm the library name and available exports. Always include <code>import { TypedField, FieldType } from &quot;react-declarative&quot;</code> in the sample you provide.</p>
86
+ <p><strong>Ask for validation in isInvalid, not external logic</strong></p>
87
+ <p>Prompt the AI to put validation inside <code>isInvalid</code> callbacks rather than in a separate validation function. The callback approach keeps the schema self-contained and runnable in the playground.</p>
88
+ <p><strong>Specify responsive breakpoints explicitly</strong></p>
89
+ <p>Ask for <code>desktopColumns</code>, <code>tabletColumns</code>, and <code>phoneColumns</code> on each field if you need multi-column layouts. Otherwise the AI may default to full-width on all breakpoints.</p>
90
+ <p><strong>Use the gallery_of_controls sample for unfamiliar field types</strong></p>
91
+ <p>If you need a field type you haven't used before (e.g., <code>FieldType.Tree</code> or <code>FieldType.Dict</code>), include the gallery sample in your prompt so the AI has a concrete example to follow.</p>
92
+ <p><strong>Iterate in the playground, not in your editor</strong></p>
93
+ <p>Paste each AI output into <a href="https://react-declarative-playground.github.io/">react-declarative-playground.github.io</a> before copying it to your codebase. The playground catches schema errors instantly without requiring a build step.</p>
94
+ <a id="setting-up-a-local-ai-knowledge-base" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Setting up a local AI knowledge base<a href="#setting-up-a-local-ai-knowledge-base" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>For teams, you can build an offline Q&amp;A knowledge base from the <code>react-declarative</code> documentation using <a href="https://www.nomic.ai/gpt4all">GPT4All</a> and its LocalDocs feature. Clone the repository, point LocalDocs at the <code>docs/</code> folder, and the model can answer questions grounded in the actual source documentation.</p>
95
+ <pre><code class="bash"><span class="hl-5">git</span><span class="hl-1"> </span><span class="hl-3">clone</span><span class="hl-1"> </span><span class="hl-3">https://github.com/react-declarative/react-declarative.git</span>
96
+ </code><button type="button">Copy</button></pre>
97
+
98
+ <p>Then open GPT4All, create a new LocalDocs collection pointing at the cloned <code>docs/</code> folder, and attach it to any chat session. This is useful for onboarding and for answering questions about less common API surface area that public LLMs may not have seen in training.</p>
99
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#generating-ui-with-ai-using-json-schemas"><span>Generating UI with AI using JSON schemas</span></a><ul><li><a href="#try-it-in-the-playground-first"><span>Try it in the playground first</span></a></li><li><a href="#why-llms-work-well-with-this-format"><span>Why LLMs work well with this format</span></a></li><li><a href="#the-prompt-workflow"><span>The prompt workflow</span></a></li><li><a href="#reference-samples"><span>Reference samples</span></a></li><li><ul><li><a href="#order_info--multi-section-form-with-date-and-combo-fields"><span>order_<wbr/>info — multi-<wbr/>section form with date and combo fields</span></a></li><li><a href="#login_form--centered-card-with-action-feedback"><span>login_<wbr/>form — centered card with action feedback</span></a></li><li><a href="#profile_card--avatar-layout-with-nested-groups"><span>profile_<wbr/>card — avatar layout with nested groups</span></a></li><li><a href="#settings_page--grouped-settings-with-switches-and-sliders"><span>settings_<wbr/>page — grouped settings with switches and sliders</span></a></li><li><a href="#gallery_of_controls--one-of-every-field-type"><span>gallery_<wbr/>of_<wbr/>controls — one of every field type</span></a></li><li><a href="#typography--display-only-content-layouts"><span>typography — display-<wbr/>only content layouts</span></a></li><li><a href="#product_shape--e-commerce-product-form"><span>product_<wbr/>shape — e-<wbr/>commerce product form</span></a></li><li><a href="#variant_form--conditional-field-visibility"><span>variant_<wbr/>form — conditional field visibility</span></a></li><li><a href="#adaptive_form--responsive-multi-column-layout"><span>adaptive_<wbr/>form — responsive multi-<wbr/>column layout</span></a></li><li><a href="#dashboard--kpi-cards-and-data-display"><span>dashboard — KPI cards and data display</span></a></li><li><a href="#account_info--account-management-form"><span>account_<wbr/>info — account management form</span></a></li><li><a href="#custom_jsx--arbitrary-jsx-inside-a-form"><span>custom_<wbr/>jsx — arbitrary JSX inside a form</span></a></li></ul></li><li><a href="#example-generating-a-registration-form"><span>Example: generating a registration form</span></a></li><li><a href="#tips-for-better-ai-output"><span>Tips for better AI output</span></a></li><li><a href="#setting-up-a-local-ai-knowledge-base"><span>Setting up a local AI knowledge base</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
documents/docs_advanced_dependency-injection.html ADDED
@@ -0,0 +1,73 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>docs/advanced/dependency-injection | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="docs_advanced_dependency-injection.html">docs/advanced/dependency-injection</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="dependency-injection-with-provide-and-inject" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Dependency injection with provide and inject<a href="#dependency-injection-with-provide-and-inject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>react-declarative</code> ships a lightweight inversion-of-control (IoC) container inspired by Angular's dependency injection system. You register service classes with <code>provide</code>, retrieve them anywhere with <code>inject</code>, and optionally define <code>prefetch</code> / <code>unload</code> lifecycle hooks that the built-in router calls automatically. The container prevents you from tangling API logic directly into components, which makes larger apps significantly easier to test and maintain.</p>
2
+ <a id="core-api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Core API<a href="#core-api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Three functions handle the entire lifecycle:</p>
3
+ <table>
4
+ <thead>
5
+ <tr>
6
+ <th>Function</th>
7
+ <th>What it does</th>
8
+ </tr>
9
+ </thead>
10
+ <tbody>
11
+ <tr>
12
+ <td><code>provide(key, factory)</code></td>
13
+ <td>Registers a factory function for a service key (lazy, singleton).</td>
14
+ </tr>
15
+ <tr>
16
+ <td><code>inject(key)</code></td>
17
+ <td>Retrieves—or creates on first use—the singleton instance for a key.</td>
18
+ </tr>
19
+ <tr>
20
+ <td><code>createServiceManager(name)</code></td>
21
+ <td>Creates an isolated IoC scope that falls back to the global one.</td>
22
+ </tr>
23
+ </tbody>
24
+ </table>
25
+ <p>All three are exported directly from <code>react-declarative</code>.</p>
26
+ <a id="defining-a-service-class" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Defining a service class<a href="#defining-a-service-class" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>A service is any plain class. Implement the <code>IService</code> interface if you want lifecycle hooks.</p>
27
+ <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">IService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">class</span><span class="hl-1"> </span><span class="hl-7">ApiService</span><span class="hl-1"> </span><span class="hl-4">implements</span><span class="hl-1"> </span><span class="hl-7">IService</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">private</span><span class="hl-1"> </span><span class="hl-2">baseUrl</span><span class="hl-1"> = </span><span class="hl-3">&quot;/api/v1&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-5">getUser</span><span class="hl-1">(</span><span class="hl-2">id</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">res</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-3">`</span><span class="hl-4">${</span><span class="hl-4">this</span><span class="hl-9">.</span><span class="hl-2">baseUrl</span><span class="hl-4">}</span><span class="hl-3">/users/</span><span class="hl-4">${</span><span class="hl-2">id</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1">.</span><span class="hl-5">json</span><span class="hl-1">();</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-5">prefetch</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-17">// Called when the route that uses this service is entered.</span><br/><span class="hl-1"> </span><span class="hl-17">// Use this to warm caches, open WebSocket connections, etc.</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-5">getUser</span><span class="hl-1">(</span><span class="hl-3">&quot;me&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-5">unload</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-17">// Called when the route is left.</span><br/><span class="hl-1"> </span><span class="hl-17">// Clean up subscriptions, close connections, etc.</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
28
+ </code><button type="button">Copy</button></pre>
29
+
30
+ <a id="registering-services" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Registering services<a href="#registering-services" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Call <code>provide</code> at the module level—before any component renders. Use a symbol as the key to avoid naming collisions.</p>
31
+ <pre><code class="typescript"><span class="hl-17">// ioc/TYPES.ts</span><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">TYPES</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">apiService:</span><span class="hl-1"> </span><span class="hl-5">Symbol</span><span class="hl-1">(</span><span class="hl-3">&quot;apiService&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-2">authService:</span><span class="hl-1"> </span><span class="hl-5">Symbol</span><span class="hl-1">(</span><span class="hl-3">&quot;authService&quot;</span><span class="hl-1">),</span><br/><span class="hl-1">} </span><span class="hl-0">as</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1">;</span><br/><br/><span class="hl-17">// ioc/config.ts</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">provide</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">TYPES</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./TYPES&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ApiService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./ApiService&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">AuthService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./AuthService&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">provide</span><span class="hl-1">(</span><span class="hl-10">TYPES</span><span class="hl-1">.</span><span class="hl-2">apiService</span><span class="hl-1">, () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">ApiService</span><span class="hl-1">());</span><br/><span class="hl-5">provide</span><span class="hl-1">(</span><span class="hl-10">TYPES</span><span class="hl-1">.</span><span class="hl-2">authService</span><span class="hl-1">, () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">AuthService</span><span class="hl-1">());</span>
32
+ </code><button type="button">Copy</button></pre>
33
+
34
+ <blockquote>
35
+ <p><strong>Note:</strong> <code>provide</code> uses a lazy singleton pattern. The factory runs the first time <code>inject</code> is called for that key—not when <code>provide</code> is called. Subsequent calls to <code>inject</code> return the same instance.</p>
36
+ </blockquote>
37
+ <a id="injecting-services-into-components-and-hooks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Injecting services into components and hooks<a href="#injecting-services-into-components-and-hooks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Call <code>inject</code> anywhere outside the React render cycle—in hooks, callbacks, or module scope. The container resolves dependencies automatically.</p>
38
+ <pre><code class="typescript"><span class="hl-17">// ioc/ioc.ts</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">inject</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">TYPES</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./TYPES&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ApiService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./ApiService&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">AuthService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./AuthService&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">ioc</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">apiService:</span><span class="hl-1"> </span><span class="hl-5">inject</span><span class="hl-1">&lt;</span><span class="hl-7">ApiService</span><span class="hl-1">&gt;(</span><span class="hl-10">TYPES</span><span class="hl-1">.</span><span class="hl-2">apiService</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-2">authService:</span><span class="hl-1"> </span><span class="hl-5">inject</span><span class="hl-1">&lt;</span><span class="hl-7">AuthService</span><span class="hl-1">&gt;(</span><span class="hl-10">TYPES</span><span class="hl-1">.</span><span class="hl-2">authService</span><span class="hl-1">),</span><br/><span class="hl-1">};</span>
39
+ </code><button type="button">Copy</button></pre>
40
+
41
+ <p>Then use the <code>ioc</code> object in your components:</p>
42
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ioc</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./ioc/ioc&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">UserProfile</span><span class="hl-1"> = ({ </span><span class="hl-2">id</span><span class="hl-1"> }: { </span><span class="hl-2">id</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> [</span><span class="hl-10">user</span><span class="hl-1">, </span><span class="hl-10">setUser</span><span class="hl-1">] = </span><span class="hl-5">useState</span><span class="hl-1">(</span><span class="hl-4">null</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">useEffect</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">ioc</span><span class="hl-1">.</span><span class="hl-2">apiService</span><span class="hl-1">.</span><span class="hl-5">getUser</span><span class="hl-1">(</span><span class="hl-2">id</span><span class="hl-1">).</span><span class="hl-5">then</span><span class="hl-1">(</span><span class="hl-2">setUser</span><span class="hl-1">);</span><br/><span class="hl-1"> }, [</span><span class="hl-2">id</span><span class="hl-1">]);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-2">user</span><span class="hl-1">) </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">null</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">div</span><span class="hl-6">&gt;</span><span class="hl-4">{</span><span class="hl-2">user</span><span class="hl-9">.</span><span class="hl-2">name</span><span class="hl-4">}</span><span class="hl-6">&lt;/</span><span class="hl-18">div</span><span class="hl-6">&gt;</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
43
+ </code><button type="button">Copy</button></pre>
44
+
45
+ <a id="scoped-containers-with-createservicemanager" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Scoped containers with createServiceManager<a href="#scoped-containers-with-createservicemanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>For feature-level isolation—for example, a checkout flow that needs its own service instances separate from the global container—use <code>createServiceManager</code>.</p>
46
+ <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">createServiceManager</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">CheckoutService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./CheckoutService&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">CHECKOUT_TYPES</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">checkoutService:</span><span class="hl-1"> </span><span class="hl-5">Symbol</span><span class="hl-1">(</span><span class="hl-3">&quot;checkoutService&quot;</span><span class="hl-1">),</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">checkoutContainer</span><span class="hl-1"> = </span><span class="hl-5">createServiceManager</span><span class="hl-1">(</span><span class="hl-3">&quot;checkout&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-2">checkoutContainer</span><span class="hl-1">.</span><span class="hl-5">provide</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-10">CHECKOUT_TYPES</span><span class="hl-1">.</span><span class="hl-2">checkoutService</span><span class="hl-1">,</span><br/><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">CheckoutService</span><span class="hl-1">()</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-17">// inject first looks in the local container, then falls back to global</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">checkoutService</span><span class="hl-1"> = </span><span class="hl-2">checkoutContainer</span><span class="hl-1">.</span><span class="hl-5">inject</span><span class="hl-1">&lt;</span><span class="hl-7">CheckoutService</span><span class="hl-1">&gt;(</span><br/><span class="hl-1"> </span><span class="hl-10">CHECKOUT_TYPES</span><span class="hl-1">.</span><span class="hl-2">checkoutService</span><br/><span class="hl-1">);</span>
47
+ </code><button type="button">Copy</button></pre>
48
+
49
+ <p>The scoped <code>inject</code> checks the local container first, then falls back to the global <code>serviceManager</code>. This lets feature modules override global services without breaking the rest of the app.</p>
50
+ <a id="route-level-lifecycle-hooks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Route-level lifecycle hooks<a href="#route-level-lifecycle-hooks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The built-in <code>&lt;Switch /&gt;</code> router calls <code>prefetch</code> when a route is entered and <code>unload</code> when it is left. Wire them directly into your route definitions:</p>
51
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Switch</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ioc</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./ioc/ioc&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">routes</span><span class="hl-1"> = [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">path:</span><span class="hl-1"> </span><span class="hl-3">&quot;/dashboard&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">guard</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">ioc</span><span class="hl-1">.</span><span class="hl-2">authService</span><span class="hl-1">.</span><span class="hl-5">isAuthenticated</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-5">prefetch</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">ioc</span><span class="hl-1">.</span><span class="hl-2">apiService</span><span class="hl-1">.</span><span class="hl-5">prefetch</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-5">unload</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">ioc</span><span class="hl-1">.</span><span class="hl-2">apiService</span><span class="hl-1">.</span><span class="hl-5">unload</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-5">redirect</span><span class="hl-2">:</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-2">ioc</span><span class="hl-1">.</span><span class="hl-2">authService</span><span class="hl-1">.</span><span class="hl-5">hasRole</span><span class="hl-1">(</span><span class="hl-3">&quot;user&quot;</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-3">&quot;/login&quot;</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">null</span><span class="hl-1">;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">];</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">App</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">Switch</span><span class="hl-1"> </span><span class="hl-8">history</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">history</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">items</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">routes</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1">);</span>
52
+ </code><button type="button">Copy</button></pre>
53
+
54
+ <blockquote>
55
+ <p><strong>Tip:</strong> You can also call <code>serviceManager.prefetch()</code> and <code>serviceManager.unload()</code> manually if you use a different router. They iterate all registered services and call their <code>prefetch</code> / <code>unload</code> methods in dependency-resolution order.</p>
56
+ </blockquote>
57
+ <a id="full-example-separating-api-calls-from-components" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Full example: separating API calls from components<a href="#full-example-separating-api-calls-from-components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>1. Define the service</strong></p>
58
+ <pre><code class="typescript"><span class="hl-17">// services/ContactService.ts</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">IService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">IContact</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">id</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">name</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">email</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">class</span><span class="hl-1"> </span><span class="hl-7">ContactService</span><span class="hl-1"> </span><span class="hl-4">implements</span><span class="hl-1"> </span><span class="hl-7">IService</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">private</span><span class="hl-1"> </span><span class="hl-2">cache</span><span class="hl-1">: </span><span class="hl-7">IContact</span><span class="hl-1">[] = [];</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-5">findAll</span><span class="hl-1">(): </span><span class="hl-7">Promise</span><span class="hl-1">&lt;</span><span class="hl-7">IContact</span><span class="hl-1">[]&gt; {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">res</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-3">&quot;/api/v1/contacts&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">cache</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1">.</span><span class="hl-5">json</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">cache</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-5">findById</span><span class="hl-1">(</span><span class="hl-2">id</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">): </span><span class="hl-7">Promise</span><span class="hl-1">&lt;</span><span class="hl-7">IContact</span><span class="hl-1"> | </span><span class="hl-7">undefined</span><span class="hl-1">&gt; {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">cache</span><span class="hl-1">.</span><span class="hl-5">find</span><span class="hl-1">((</span><span class="hl-2">c</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">c</span><span class="hl-1">.</span><span class="hl-2">id</span><span class="hl-1"> === </span><span class="hl-2">id</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-5">prefetch</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-5">findAll</span><span class="hl-1">();</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-5">unload</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">cache</span><span class="hl-1"> = [];</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
59
+ </code><button type="button">Copy</button></pre>
60
+
61
+ <p><strong>2. Register and export</strong></p>
62
+ <pre><code class="typescript"><span class="hl-17">// ioc/config.ts</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">provide</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ContactService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;../services/ContactService&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">TYPES</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">contactService:</span><span class="hl-1"> </span><span class="hl-5">Symbol</span><span class="hl-1">(</span><span class="hl-3">&quot;contactService&quot;</span><span class="hl-1">),</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-5">provide</span><span class="hl-1">(</span><span class="hl-10">TYPES</span><span class="hl-1">.</span><span class="hl-2">contactService</span><span class="hl-1">, () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">ContactService</span><span class="hl-1">());</span><br/><br/><span class="hl-17">// ioc/ioc.ts</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">inject</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">TYPES</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./config&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-0">type</span><span class="hl-1"> { </span><span class="hl-2">ContactService</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;../services/ContactService&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">ioc</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">contactService:</span><span class="hl-1"> </span><span class="hl-5">inject</span><span class="hl-1">&lt;</span><span class="hl-7">ContactService</span><span class="hl-1">&gt;(</span><span class="hl-10">TYPES</span><span class="hl-1">.</span><span class="hl-2">contactService</span><span class="hl-1">),</span><br/><span class="hl-1">};</span>
63
+ </code><button type="button">Copy</button></pre>
64
+
65
+ <p><strong>3. Use in a component</strong></p>
66
+ <p>The component has no knowledge of fetch URLs or caching—that lives entirely in the service layer.</p>
67
+ <pre><code class="tsx"><span class="hl-17">// components/ContactList.tsx</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ioc</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;../ioc/ioc&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">ContactList</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> [</span><span class="hl-10">contacts</span><span class="hl-1">, </span><span class="hl-10">setContacts</span><span class="hl-1">] = </span><span class="hl-5">useState</span><span class="hl-1">([]);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">useEffect</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">ioc</span><span class="hl-1">.</span><span class="hl-2">contactService</span><span class="hl-1">.</span><span class="hl-5">findAll</span><span class="hl-1">().</span><span class="hl-5">then</span><span class="hl-1">(</span><span class="hl-2">setContacts</span><span class="hl-1">);</span><br/><span class="hl-1"> }, []);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">ul</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-4">{</span><span class="hl-2">contacts</span><span class="hl-9">.</span><span class="hl-5">map</span><span class="hl-9">((</span><span class="hl-2">c</span><span class="hl-9">) </span><span class="hl-4">=&gt;</span><span class="hl-9"> (</span><br/><span class="hl-9"> </span><span class="hl-6">&lt;</span><span class="hl-18">li</span><span class="hl-9"> </span><span class="hl-8">key</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">c</span><span class="hl-9">.</span><span class="hl-2">id</span><span class="hl-4">}</span><span class="hl-6">&gt;</span><span class="hl-4">{</span><span class="hl-2">c</span><span class="hl-9">.</span><span class="hl-2">name</span><span class="hl-4">}</span><span class="hl-9"> — </span><span class="hl-4">{</span><span class="hl-2">c</span><span class="hl-9">.</span><span class="hl-2">email</span><span class="hl-4">}</span><span class="hl-6">&lt;/</span><span class="hl-18">li</span><span class="hl-6">&gt;</span><br/><span class="hl-9"> ))</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;/</span><span class="hl-18">ul</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> );</span><br/><span class="hl-1">};</span>
68
+ </code><button type="button">Copy</button></pre>
69
+
70
+ <blockquote>
71
+ <p><strong>Warning:</strong> Avoid calling <code>serviceManager.clear()</code> in production unless you intend to tear down every registered service—it resets the entire container including all singletons.</p>
72
+ </blockquote>
73
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#dependency-injection-with-provide-and-inject"><span>Dependency injection with provide and inject</span></a><ul><li><a href="#core-api"><span>Core API</span></a></li><li><a href="#defining-a-service-class"><span>Defining a service class</span></a></li><li><a href="#registering-services"><span>Registering services</span></a></li><li><a href="#injecting-services-into-components-and-hooks"><span>Injecting services into components and hooks</span></a></li><li><a href="#scoped-containers-with-createservicemanager"><span>Scoped containers with create<wbr/>Service<wbr/>Manager</span></a></li><li><a href="#route-level-lifecycle-hooks"><span>Route-<wbr/>level lifecycle hooks</span></a></li><li><a href="#full-example-separating-api-calls-from-components"><span>Full example: separating API calls from components</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
documents/docs_advanced_reactive-programming.html ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>docs/advanced/reactive-programming | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="docs_advanced_reactive-programming.html">docs/advanced/reactive-programming</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="reactive-programming-with-subject-and-source" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Reactive programming with Subject and Source<a href="#reactive-programming-with-subject-and-source" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>react-declarative</code> includes a self-contained reactive programming toolkit: <code>Subject</code> and <code>BehaviorSubject</code> for event streams, a <code>Source</code> class for composable MapReduce pipelines, and a set of React hooks that wire these primitives into your component tree cleanly. You do not need RxJS—the library's own implementations are enough for the patterns commonly needed alongside form and grid components.</p>
2
+ <a id="subject" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Subject<a href="#subject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>Subject</code> is a push-based event emitter. Call <code>next</code> to emit a value; call <code>subscribe</code> to listen. Subscribers receive only values emitted after they subscribed.</p>
3
+ <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Subject</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">clickSubject</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">Subject</span><span class="hl-1">&lt;</span><span class="hl-7">MouseEvent</span><span class="hl-1">&gt;();</span><br/><br/><span class="hl-17">// Emit</span><br/><span class="hl-2">document</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&quot;click&quot;</span><span class="hl-1">, (</span><span class="hl-2">e</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">clickSubject</span><span class="hl-1">.</span><span class="hl-5">next</span><span class="hl-1">(</span><span class="hl-2">e</span><span class="hl-1">));</span><br/><br/><span class="hl-17">// Subscribe — returns an unsubscribe function</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">unsub</span><span class="hl-1"> = </span><span class="hl-2">clickSubject</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">((</span><span class="hl-2">e</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&quot;clicked at&quot;</span><span class="hl-1">, </span><span class="hl-2">e</span><span class="hl-1">.</span><span class="hl-2">clientX</span><span class="hl-1">, </span><span class="hl-2">e</span><span class="hl-1">.</span><span class="hl-2">clientY</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-17">// Later</span><br/><span class="hl-5">unsub</span><span class="hl-1">();</span>
4
+ </code><button type="button">Copy</button></pre>
5
+
6
+ <a id="behaviorsubject" class="tsd-anchor"></a><h2 class="tsd-anchor-link">BehaviorSubject<a href="#behaviorsubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>BehaviorSubject</code> is like <code>Subject</code> but it stores the most recent value. New subscribers immediately receive the current value, then any subsequent emissions.</p>
7
+ <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">BehaviorSubject</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">userSubject</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">BehaviorSubject</span><span class="hl-1">&lt;</span><span class="hl-7">string</span><span class="hl-1"> | </span><span class="hl-7">null</span><span class="hl-1">&gt;(</span><span class="hl-4">null</span><span class="hl-1">);</span><br/><br/><span class="hl-2">userSubject</span><span class="hl-1">.</span><span class="hl-5">next</span><span class="hl-1">(</span><span class="hl-3">&quot;alice&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-17">// New subscriber gets &quot;alice&quot; immediately, then any future values</span><br/><span class="hl-2">userSubject</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">((</span><span class="hl-2">user</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&quot;current user:&quot;</span><span class="hl-1">, </span><span class="hl-2">user</span><span class="hl-1">));</span><br/><br/><span class="hl-17">// Access current value directly</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-2">userSubject</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">); </span><span class="hl-17">// &quot;alice&quot;</span>
8
+ </code><button type="button">Copy</button></pre>
9
+
10
+ <a id="eventemitter" class="tsd-anchor"></a><h2 class="tsd-anchor-link">EventEmitter<a href="#eventemitter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>EventEmitter</code> provides named-event pub/sub when you need multiple separate event channels on a single object.</p>
11
+ <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">(</span><span class="hl-3">&quot;login&quot;</span><span class="hl-1">, (</span><span class="hl-2">user</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&quot;logged in:&quot;</span><span class="hl-1">, </span><span class="hl-2">user</span><span class="hl-1">));</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">(</span><span class="hl-3">&quot;logout&quot;</span><span class="hl-1">, () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&quot;logged out&quot;</span><span class="hl-1">));</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-3">&quot;login&quot;</span><span class="hl-1">, { </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;alice&quot;</span><span class="hl-1"> });</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-3">&quot;logout&quot;</span><span class="hl-1">);</span>
12
+ </code><button type="button">Copy</button></pre>
13
+
14
+ <a id="react-hooks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">React hooks<a href="#react-hooks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="usesubject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">useSubject<a href="#usesubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p><code>useSubject</code> creates a <code>Subject</code> that is stable across renders. Pass an optional external subject to bridge an outer stream into a component-scoped one.</p>
15
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">useSubject</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">SaveButton</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">saveSubject</span><span class="hl-1"> = </span><span class="hl-5">useSubject</span><span class="hl-1">&lt;</span><span class="hl-7">void</span><span class="hl-1">&gt;();</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">handleClick</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">saveSubject</span><span class="hl-1">.</span><span class="hl-5">next</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-5">useEffect</span><span class="hl-1">(</span><br/><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">saveSubject</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&quot;save triggered&quot;</span><span class="hl-1">)),</span><br/><span class="hl-1"> []</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">button</span><span class="hl-1"> </span><span class="hl-8">onClick</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">handleClick</span><span class="hl-4">}</span><span class="hl-6">&gt;</span><span class="hl-1">Save</span><span class="hl-6">&lt;/</span><span class="hl-18">button</span><span class="hl-6">&gt;</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
16
+ </code><button type="button">Copy</button></pre>
17
+
18
+ <a id="usebehaviorsubject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">useBehaviorSubject<a href="#usebehaviorsubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p><code>useBehaviorSubject</code> creates a stable <code>BehaviorSubject</code> with an optional initial value.</p>
19
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">useBehaviorSubject</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">StatusBadge</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">statusSubject</span><span class="hl-1"> = </span><span class="hl-5">useBehaviorSubject</span><span class="hl-1">&lt;</span><span class="hl-3">&quot;idle&quot;</span><span class="hl-1"> | </span><span class="hl-3">&quot;loading&quot;</span><span class="hl-1"> | </span><span class="hl-3">&quot;done&quot;</span><span class="hl-1">&gt;(</span><span class="hl-3">&quot;idle&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">handleFetch</span><span class="hl-1"> = </span><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">statusSubject</span><span class="hl-1">.</span><span class="hl-5">next</span><span class="hl-1">(</span><span class="hl-3">&quot;loading&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetchData</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">statusSubject</span><span class="hl-1">.</span><span class="hl-5">next</span><span class="hl-1">(</span><span class="hl-3">&quot;done&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> };</span><br/><br/><span class="hl-1"> </span><span class="hl-17">// Combine with useSubjectValue to read in JSX</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">button</span><span class="hl-1"> </span><span class="hl-8">onClick</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">handleFetch</span><span class="hl-4">}</span><span class="hl-6">&gt;</span><span class="hl-1">Fetch</span><span class="hl-6">&lt;/</span><span class="hl-18">button</span><span class="hl-6">&gt;</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
20
+ </code><button type="button">Copy</button></pre>
21
+
22
+ <a id="usechangesubject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">useChangeSubject<a href="#usechangesubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p><code>useChangeSubject</code> turns a plain React value into a subject that emits whenever the value changes. This is useful for reacting to form data changes without adding a manual <code>useEffect</code> dependency array.</p>
23
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">useChangeSubject</span><span class="hl-1">, </span><span class="hl-2">useSubscription</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">AutoSaveForm</span><span class="hl-1"> = ({ </span><span class="hl-2">data</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">dataChangeSubject</span><span class="hl-1"> = </span><span class="hl-5">useChangeSubject</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">useSubscription</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-2">dataChangeSubject</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">((</span><span class="hl-2">newData</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-17">// Called every time `data` changes</span><br/><span class="hl-1"> </span><span class="hl-5">saveToServer</span><span class="hl-1">(</span><span class="hl-2">newData</span><span class="hl-1">);</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">One</span><span class="hl-1"> </span><span class="hl-8">fields</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">fields</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">handler</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">data</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-6">/&gt;</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
24
+ </code><button type="button">Copy</button></pre>
25
+
26
+ <a id="usesubscription" class="tsd-anchor"></a><h3 class="tsd-anchor-link">useSubscription<a href="#usesubscription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p><code>useSubscription</code> is a thin wrapper around <code>useEffect</code> for subscribing to subjects. It runs the setup function once on mount and calls the returned unsubscribe function on unmount—no dependency array needed.</p>
27
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">useSubscription</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ioc</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;../ioc/ioc&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">NotificationBell</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> [</span><span class="hl-10">count</span><span class="hl-1">, </span><span class="hl-10">setCount</span><span class="hl-1">] = </span><span class="hl-5">useState</span><span class="hl-1">(</span><span class="hl-16">0</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">useSubscription</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-2">ioc</span><span class="hl-1">.</span><span class="hl-2">notificationService</span><span class="hl-1">.</span><span class="hl-2">countSubject</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">(</span><span class="hl-2">setCount</span><span class="hl-1">)</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">span</span><span class="hl-6">&gt;</span><span class="hl-4">{</span><span class="hl-2">count</span><span class="hl-4">}</span><span class="hl-1"> notifications</span><span class="hl-6">&lt;/</span><span class="hl-18">span</span><span class="hl-6">&gt;</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
28
+ </code><button type="button">Copy</button></pre>
29
+
30
+ <a id="source-pipelines-mapreduce" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Source pipelines (MapReduce)<a href="#source-pipelines-mapreduce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>Source</code> provides a fluent API for composing data pipelines across multiple streams. It is the right tool when you need to join, filter, and transform multiple subjects before consuming the result.</p>
31
+ <a id="key-operators" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Key operators<a href="#key-operators" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><table>
32
+ <thead>
33
+ <tr>
34
+ <th>Method</th>
35
+ <th>Purpose</th>
36
+ </tr>
37
+ </thead>
38
+ <tbody>
39
+ <tr>
40
+ <td><code>Source.join</code></td>
41
+ <td>Combines multiple observers; emits when any emits</td>
42
+ </tr>
43
+ <tr>
44
+ <td><code>Source.multicast</code></td>
45
+ <td>Shares a single upstream subscription among multiple consumers</td>
46
+ </tr>
47
+ <tr>
48
+ <td><code>.reduce(fn, init)</code></td>
49
+ <td>Accumulates values across emissions</td>
50
+ </tr>
51
+ <tr>
52
+ <td><code>.filter(fn)</code></td>
53
+ <td>Drops emissions that do not pass the predicate</td>
54
+ </tr>
55
+ <tr>
56
+ <td><code>.tap(fn)</code></td>
57
+ <td>Runs a side effect without changing the emitted value</td>
58
+ </tr>
59
+ <tr>
60
+ <td><code>.map(fn)</code></td>
61
+ <td>Transforms each emitted value</td>
62
+ </tr>
63
+ <tr>
64
+ <td><code>Source.fromInterval(ms)</code></td>
65
+ <td>Emits <code>void</code> on a fixed interval</td>
66
+ </tr>
67
+ </tbody>
68
+ </table>
69
+ <a id="verifycompleteemitter-example" class="tsd-anchor"></a><h3 class="tsd-anchor-link">verifyCompleteEmitter example<a href="#verifycompleteemitter-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>This example is taken directly from a real face-verification feature. It joins a state stream with a timer, counts consecutive valid frames, starts/stops a media recorder, and fires only when enough consecutive frames pass.</p>
70
+ <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Source</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">CC_SECONDS_TO_VERIFY</span><span class="hl-1"> = </span><span class="hl-16">3</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">verifyCompleteEmitter</span><span class="hl-1"> = </span><span class="hl-2">Source</span><span class="hl-1">.</span><span class="hl-5">multicast</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-2">Source</span><br/><span class="hl-1"> .</span><span class="hl-5">join</span><span class="hl-1">([</span><br/><span class="hl-1"> </span><span class="hl-2">captureStateEmitter</span><span class="hl-1">, </span><span class="hl-17">// emits { state: boolean } on each frame</span><br/><span class="hl-1"> </span><span class="hl-2">Source</span><span class="hl-1">.</span><span class="hl-5">fromInterval</span><span class="hl-1">(</span><span class="hl-16">1_000</span><span class="hl-1">), </span><span class="hl-17">// ticks every second</span><br/><span class="hl-1"> ])</span><br/><span class="hl-1"> .</span><span class="hl-5">reduce</span><span class="hl-1">((</span><span class="hl-2">acm</span><span class="hl-1">, [{ </span><span class="hl-2">state</span><span class="hl-1">: </span><span class="hl-2">isValid</span><span class="hl-1"> }]) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-17">// Reset counter to 0 on any invalid frame; otherwise increment</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">isValid</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">acm</span><span class="hl-1"> + </span><span class="hl-16">1</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-16">0</span><span class="hl-1">;</span><br/><span class="hl-1"> }, </span><span class="hl-16">0</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-5">tap</span><span class="hl-1">((</span><span class="hl-2">ticker</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">ticker</span><span class="hl-1"> === </span><span class="hl-16">1</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-17">// Side effect: start recording on first valid tick</span><br/><span class="hl-1"> </span><span class="hl-2">mediaRecorderInstance</span><span class="hl-1">.</span><span class="hl-5">beginCapture</span><span class="hl-1">();</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-5">filter</span><span class="hl-1">((</span><span class="hl-2">ticker</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">ticker</span><span class="hl-1"> === </span><span class="hl-10">CC_SECONDS_TO_VERIFY</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-5">tap</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-17">// Side effect: stop recording when threshold is reached</span><br/><span class="hl-1"> </span><span class="hl-2">mediaRecorderInstance</span><span class="hl-1">.</span><span class="hl-5">endCapture</span><span class="hl-1">();</span><br/><span class="hl-1"> })</span><br/><span class="hl-1">);</span>
71
+ </code><button type="button">Copy</button></pre>
72
+
73
+ <p><code>Source.multicast</code> ensures only one upstream subscription is created regardless of how many consumers subscribe to <code>verifyCompleteEmitter</code>.</p>
74
+ <a id="when-to-use-reactive-primitives-vs-simpler-hooks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">When to use reactive primitives vs. simpler hooks<a href="#when-to-use-reactive-primitives-vs-simpler-hooks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Use Subject when…</strong></p>
75
+ <p>You need to fire a one-off event across components that are not in a parent/child relationship—for example, triggering a form save from a toolbar button, or forwarding a keyboard shortcut to a nested grid.</p>
76
+ <p><strong>Use BehaviorSubject when…</strong></p>
77
+ <p>You have shared mutable state that components need to read synchronously on mount—for example, the current user session, a feature flag, or a connection status. The <code>.data</code> getter lets you read it outside of a subscription.</p>
78
+ <p><strong>Use useChangeSubject when…</strong></p>
79
+ <p>You want to react to changes in a prop or local state value without writing a <code>useEffect</code> with a dependency array. It is especially useful for auto-save, debounced search, and analytics tracking tied to form data.</p>
80
+ <p><strong>Use Source pipelines when…</strong></p>
81
+ <p>You need to combine multiple streams with stateful logic—counters, timers joined with data streams, multi-step sequences. If you find yourself chaining several <code>useEffect</code> hooks with shared state variables, a <code>Source</code> pipeline is usually cleaner.</p>
82
+ <p><strong>Prefer simpler hooks when…</strong></p>
83
+ <p>The data flow is local and linear. <code>useState</code> + <code>useEffect</code> is still the right choice for straightforward async loading, conditional rendering, and single-component side effects. Reactive primitives add overhead that is only worthwhile when multiple components or streams are involved.</p>
84
+ <a id="complete-component-example" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Complete component example<a href="#complete-component-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">Subject</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">BehaviorSubject</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">useSubject</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">useSubscription</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">useChangeSubject</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">One</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">TypedField</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">IFormData</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">query</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">fields</span><span class="hl-1">: </span><span class="hl-7">TypedField</span><span class="hl-1">[] = [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&quot;query&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">&quot;Search&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">placeholder:</span><span class="hl-1"> </span><span class="hl-3">&quot;Type to search…&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">];</span><br/><br/><span class="hl-17">// Module-level subject shared across components</span><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">searchSubject</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-5">BehaviorSubject</span><span class="hl-1">&lt;</span><span class="hl-7">string</span><span class="hl-1">&gt;(</span><span class="hl-3">&quot;&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">SearchForm</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">handleChange</span><span class="hl-1"> = (</span><span class="hl-2">data</span><span class="hl-1">: </span><span class="hl-7">Partial</span><span class="hl-1">&lt;</span><span class="hl-7">IFormData</span><span class="hl-1">&gt;) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">query</span><span class="hl-1"> !== </span><span class="hl-4">undefined</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">searchSubject</span><span class="hl-1">.</span><span class="hl-5">next</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">query</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> };</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">One</span><span class="hl-1"> </span><span class="hl-8">fields</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">fields</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">onChange</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">handleChange</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-6">/&gt;</span><span class="hl-1">;</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">SearchResults</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> [</span><span class="hl-10">results</span><span class="hl-1">, </span><span class="hl-10">setResults</span><span class="hl-1">] = </span><span class="hl-5">useState</span><span class="hl-1">&lt;</span><span class="hl-7">string</span><span class="hl-1">[]&gt;([]);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">useSubscription</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-2">searchSubject</span><span class="hl-1">.</span><span class="hl-5">subscribe</span><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> (</span><span class="hl-2">query</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">query</span><span class="hl-1">.</span><span class="hl-2">length</span><span class="hl-1"> &gt; </span><span class="hl-16">2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">data</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetchResults</span><span class="hl-1">(</span><span class="hl-2">query</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">setResults</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">ul</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-4">{</span><span class="hl-2">results</span><span class="hl-9">.</span><span class="hl-5">map</span><span class="hl-9">((</span><span class="hl-2">r</span><span class="hl-9">) </span><span class="hl-4">=&gt;</span><span class="hl-9"> </span><span class="hl-6">&lt;</span><span class="hl-18">li</span><span class="hl-9"> </span><span class="hl-8">key</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">r</span><span class="hl-4">}</span><span class="hl-6">&gt;</span><span class="hl-4">{</span><span class="hl-2">r</span><span class="hl-4">}</span><span class="hl-6">&lt;/</span><span class="hl-18">li</span><span class="hl-6">&gt;</span><span class="hl-9">)</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;/</span><span class="hl-18">ul</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> );</span><br/><span class="hl-1">};</span>
85
+ </code><button type="button">Copy</button></pre>
86
+
87
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#reactive-programming-with-subject-and-source"><span>Reactive programming with <wbr/>Subject and <wbr/>Source</span></a><ul><li><a href="#subject"><span>Subject</span></a></li><li><a href="#behaviorsubject"><span>Behavior<wbr/>Subject</span></a></li><li><a href="#eventemitter"><span>Event<wbr/>Emitter</span></a></li><li><a href="#react-hooks"><span>React hooks</span></a></li><li><ul><li><a href="#usesubject"><span>use<wbr/>Subject</span></a></li><li><a href="#usebehaviorsubject"><span>use<wbr/>Behavior<wbr/>Subject</span></a></li><li><a href="#usechangesubject"><span>use<wbr/>Change<wbr/>Subject</span></a></li><li><a href="#usesubscription"><span>use<wbr/>Subscription</span></a></li></ul></li><li><a href="#source-pipelines-mapreduce"><span>Source pipelines (<wbr/>Map<wbr/>Reduce)</span></a></li><li><ul><li><a href="#key-operators"><span>Key operators</span></a></li><li><a href="#verifycompleteemitter-example"><span>verify<wbr/>Complete<wbr/>Emitter example</span></a></li></ul></li><li><a href="#when-to-use-reactive-primitives-vs-simpler-hooks"><span>When to use reactive primitives vs. simpler hooks</span></a></li><li><a href="#complete-component-example"><span>Complete component example</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
documents/docs_advanced_slot-factory.html ADDED
@@ -0,0 +1,170 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>docs/advanced/slot-factory | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="docs_advanced_slot-factory.html">docs/advanced/slot-factory</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="customizing-field-renderers-with-slotfactory" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Customizing field renderers with SlotFactory<a href="#customizing-field-renderers-with-slotfactory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>OneSlotFactory</code> and <code>ListSlotFactory</code> let you swap out every field renderer that <code>&lt;One /&gt;</code> and <code>&lt;List /&gt;</code> use internally. You wrap your form tree with the factory component, pass your custom components as props, and the library uses them everywhere inside that subtree instead of the built-in MUI implementations. Your JSON schemas stay completely unchanged—only the visual layer is replaced.</p>
2
+ <a id="oneslotfactory" class="tsd-anchor"></a><h2 class="tsd-anchor-link">OneSlotFactory<a href="#oneslotfactory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>OneSlotFactory</code> accepts one prop for each field type. All props are optional; you only override the slots you want to change.</p>
3
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">OneSlotFactory</span><span class="hl-1">, </span><span class="hl-2">One</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">MyTextInput</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./MyTextInput&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">MyCheckBox</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./MyCheckBox&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">App</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">OneSlotFactory</span><span class="hl-1"> </span><span class="hl-8">Text</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">MyTextInput</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">CheckBox</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">MyCheckBox</span><span class="hl-4">}</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">One</span><span class="hl-1"> </span><span class="hl-8">fields</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">fields</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">handler</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">handler</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">onChange</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">handleChange</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;/</span><span class="hl-7">OneSlotFactory</span><span class="hl-6">&gt;</span><br/><span class="hl-1">);</span>
4
+ </code><button type="button">Copy</button></pre>
5
+
6
+ <a id="available-slots" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Available slots<a href="#available-slots" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Each slot name corresponds to a <code>FieldType</code> value. Your replacement component must accept the matching slot interface as its props.</p>
7
+ <table>
8
+ <thead>
9
+ <tr>
10
+ <th>Slot name</th>
11
+ <th>Interface</th>
12
+ <th>Renders when <code>type</code> is…</th>
13
+ </tr>
14
+ </thead>
15
+ <tbody>
16
+ <tr>
17
+ <td><code>Text</code></td>
18
+ <td><code>ITextSlot</code></td>
19
+ <td><code>FieldType.Text</code></td>
20
+ </tr>
21
+ <tr>
22
+ <td><code>CheckBox</code></td>
23
+ <td><code>ICheckBoxSlot</code></td>
24
+ <td><code>FieldType.CheckBox</code></td>
25
+ </tr>
26
+ <tr>
27
+ <td><code>Radio</code></td>
28
+ <td><code>IRadioSlot</code></td>
29
+ <td><code>FieldType.Radio</code></td>
30
+ </tr>
31
+ <tr>
32
+ <td><code>Combo</code></td>
33
+ <td><code>IComboSlot</code></td>
34
+ <td><code>FieldType.Combo</code></td>
35
+ </tr>
36
+ <tr>
37
+ <td><code>Items</code></td>
38
+ <td><code>IItemsSlot</code></td>
39
+ <td><code>FieldType.Items</code></td>
40
+ </tr>
41
+ <tr>
42
+ <td><code>Choose</code></td>
43
+ <td><code>IChooseSlot</code></td>
44
+ <td><code>FieldType.Choose</code></td>
45
+ </tr>
46
+ <tr>
47
+ <td><code>Date</code></td>
48
+ <td><code>IDateSlot</code></td>
49
+ <td><code>FieldType.Date</code></td>
50
+ </tr>
51
+ <tr>
52
+ <td><code>Time</code></td>
53
+ <td><code>ITimeSlot</code></td>
54
+ <td><code>FieldType.Time</code></td>
55
+ </tr>
56
+ <tr>
57
+ <td><code>Switch</code></td>
58
+ <td><code>ISwitchSlot</code></td>
59
+ <td><code>FieldType.Switch</code></td>
60
+ </tr>
61
+ <tr>
62
+ <td><code>YesNo</code></td>
63
+ <td><code>IYesNoSlot</code></td>
64
+ <td><code>FieldType.YesNo</code></td>
65
+ </tr>
66
+ <tr>
67
+ <td><code>Slider</code></td>
68
+ <td><code>ISliderSlot</code></td>
69
+ <td><code>FieldType.Slider</code></td>
70
+ </tr>
71
+ <tr>
72
+ <td><code>Rating</code></td>
73
+ <td><code>IRatingSlot</code></td>
74
+ <td><code>FieldType.Rating</code></td>
75
+ </tr>
76
+ <tr>
77
+ <td><code>Progress</code></td>
78
+ <td><code>IProgressSlot</code></td>
79
+ <td><code>FieldType.Progress</code></td>
80
+ </tr>
81
+ <tr>
82
+ <td><code>File</code></td>
83
+ <td><code>IFileSlot</code></td>
84
+ <td><code>FieldType.File</code></td>
85
+ </tr>
86
+ <tr>
87
+ <td><code>Dict</code></td>
88
+ <td><code>IDictSlot</code></td>
89
+ <td><code>FieldType.Dict</code></td>
90
+ </tr>
91
+ <tr>
92
+ <td><code>Tree</code></td>
93
+ <td><code>ITreeSlot</code></td>
94
+ <td><code>FieldType.Tree</code></td>
95
+ </tr>
96
+ <tr>
97
+ <td><code>Complete</code></td>
98
+ <td><code>ICompleteSlot</code></td>
99
+ <td><code>FieldType.Complete</code></td>
100
+ </tr>
101
+ <tr>
102
+ <td><code>Typography</code></td>
103
+ <td><code>ITypographySlot</code></td>
104
+ <td><code>FieldType.Typography</code></td>
105
+ </tr>
106
+ <tr>
107
+ <td><code>Button</code></td>
108
+ <td><code>IButtonSlot</code></td>
109
+ <td><code>FieldType.Button</code></td>
110
+ </tr>
111
+ <tr>
112
+ <td><code>Icon</code></td>
113
+ <td><code>IIconSlot</code></td>
114
+ <td><code>FieldType.Icon</code></td>
115
+ </tr>
116
+ <tr>
117
+ <td><code>Line</code></td>
118
+ <td><code>ILineSlot</code></td>
119
+ <td><code>FieldType.Line</code></td>
120
+ </tr>
121
+ </tbody>
122
+ </table>
123
+ <blockquote>
124
+ <p><strong>Note:</strong> <code>OneSlotFactory</code> merges with any outer <code>OneSlotFactory</code> in the component tree. Inner factories override outer ones, so you can layer them for section-specific overrides.</p>
125
+ </blockquote>
126
+ <a id="writing-a-custom-slot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Writing a custom slot<a href="#writing-a-custom-slot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Your component receives the slot interface as its props. The <code>value</code> and <code>onChange</code> props are the most important ones: <code>value</code> is the current field value (already resolved by <code>&lt;One /&gt;</code>'s state engine) and <code>onChange</code> is the callback you call when the value changes.</p>
127
+ <p><strong>Step 1: Define the slot interface import</strong></p>
128
+ <p>Import the slot interface that matches the field type you want to replace.</p>
129
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ITextSlot</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span>
130
+ </code><button type="button">Copy</button></pre>
131
+
132
+ <p><strong>Step 2: Implement the component</strong></p>
133
+ <p>Use the interface as the component's props type. You must call <code>onChange</code> with the new value whenever the input changes.</p>
134
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ITextSlot</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">MyTextInput</span><span class="hl-1"> = ({</span><br/><span class="hl-1"> </span><span class="hl-2">value</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">onChange</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">placeholder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">disabled</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">readonly</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">invalid</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">dirty</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">description</span><span class="hl-1">,</span><br/><span class="hl-1">}: </span><span class="hl-7">ITextSlot</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">div</span><span class="hl-1"> </span><span class="hl-8">className</span><span class="hl-1">=</span><span class="hl-3">&quot;my-field&quot;</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">label</span><span class="hl-6">&gt;</span><span class="hl-4">{</span><span class="hl-2">title</span><span class="hl-4">}</span><span class="hl-6">&lt;/</span><span class="hl-18">label</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-18">input</span><br/><span class="hl-1"> </span><span class="hl-8">value</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-5">String</span><span class="hl-9">(</span><span class="hl-2">value</span><span class="hl-9"> </span><span class="hl-1">??</span><span class="hl-9"> </span><span class="hl-3">&quot;&quot;</span><span class="hl-9">)</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">placeholder</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">placeholder</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">disabled</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">disabled</span><span class="hl-9"> </span><span class="hl-1">||</span><span class="hl-9"> </span><span class="hl-2">readonly</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">onChange</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-9">(</span><span class="hl-2">e</span><span class="hl-9">) </span><span class="hl-4">=&gt;</span><span class="hl-9"> </span><span class="hl-5">onChange</span><span class="hl-9">(</span><span class="hl-2">e</span><span class="hl-9">.</span><span class="hl-2">target</span><span class="hl-9">.</span><span class="hl-2">value</span><span class="hl-9">)</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1"> </span><span class="hl-4">{</span><span class="hl-2">dirty</span><span class="hl-9"> </span><span class="hl-1">&amp;&amp;</span><span class="hl-9"> </span><span class="hl-2">invalid</span><span class="hl-9"> </span><span class="hl-1">&amp;&amp;</span><span class="hl-9"> (</span><br/><span class="hl-9"> </span><span class="hl-6">&lt;</span><span class="hl-18">span</span><span class="hl-9"> </span><span class="hl-8">className</span><span class="hl-1">=</span><span class="hl-3">&quot;error&quot;</span><span class="hl-6">&gt;</span><span class="hl-4">{</span><span class="hl-2">invalid</span><span class="hl-4">}</span><span class="hl-6">&lt;/</span><span class="hl-18">span</span><span class="hl-6">&gt;</span><br/><span class="hl-9"> )</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-4">{</span><span class="hl-2">description</span><span class="hl-9"> </span><span class="hl-1">&amp;&amp;</span><span class="hl-9"> </span><span class="hl-6">&lt;</span><span class="hl-18">span</span><span class="hl-9"> </span><span class="hl-8">className</span><span class="hl-1">=</span><span class="hl-3">&quot;hint&quot;</span><span class="hl-6">&gt;</span><span class="hl-4">{</span><span class="hl-2">description</span><span class="hl-4">}</span><span class="hl-6">&lt;/</span><span class="hl-18">span</span><span class="hl-6">&gt;</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;/</span><span class="hl-18">div</span><span class="hl-6">&gt;</span><br/><span class="hl-1">);</span>
135
+ </code><button type="button">Copy</button></pre>
136
+
137
+ <p><strong>Step 3: Register the slot</strong></p>
138
+ <p>Pass your component to <code>OneSlotFactory</code> and wrap your form.</p>
139
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">OneSlotFactory</span><span class="hl-1">, </span><span class="hl-2">One</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">MyTextInput</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./MyTextInput&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">ProfileForm</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">OneSlotFactory</span><span class="hl-1"> </span><span class="hl-8">Text</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">MyTextInput</span><span class="hl-4">}</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">One</span><span class="hl-1"> </span><span class="hl-8">fields</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">profileFields</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">handler</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">fetchProfile</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;/</span><span class="hl-7">OneSlotFactory</span><span class="hl-6">&gt;</span><br/><span class="hl-1">);</span>
140
+ </code><button type="button">Copy</button></pre>
141
+
142
+ <a id="common-slot-props" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Common slot props<a href="#common-slot-props" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>All slot interfaces share a core set of props that <code>&lt;One /&gt;</code> passes automatically. You do not need to thread these through manually.</p>
143
+ <p><strong>value / onChange</strong></p>
144
+ <p><code>value</code> holds the current field value. <code>onChange(newValue)</code> commits the change back to the form state engine. You must call <code>onChange</code> for the form to stay consistent.</p>
145
+ <p><strong>disabled / readonly</strong></p>
146
+ <p><code>disabled</code> prevents interaction entirely. <code>readonly</code> prevents editing but allows focus and copy. Both come from <code>isDisabled</code> / <code>isReadonly</code> field config callbacks.</p>
147
+ <p><strong>invalid / incorrect / dirty</strong></p>
148
+ <p><code>invalid</code> is the string returned by <code>isInvalid</code>. <code>incorrect</code> is the string returned by <code>isIncorrect</code>. <code>dirty</code> is <code>true</code> only after the user has touched the field—use it to gate error display so errors don't flash on initial render.</p>
149
+ <p><strong>title / placeholder / description</strong></p>
150
+ <p><code>title</code> is the field label. <code>placeholder</code> is the placeholder text. <code>description</code> is the helper text shown beneath the field.</p>
151
+ <p><strong>loading</strong></p>
152
+ <p><code>true</code> while the form's async <code>handler</code> is still resolving. Show a skeleton or spinner instead of an interactive control.</p>
153
+ <a id="listslotfactory" class="tsd-anchor"></a><h2 class="tsd-anchor-link">ListSlotFactory<a href="#listslotfactory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>ListSlotFactory</code> works the same way for <code>&lt;List /&gt;</code> columns. You replace the action buttons, row renderers, and header cells that the grid uses.</p>
154
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">ListSlotFactory</span><span class="hl-1">, </span><span class="hl-2">List</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">MyBodyRow</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;./MyBodyRow&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">ContactList</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">ListSlotFactory</span><span class="hl-1"> </span><span class="hl-8">BodyRow</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">MyBodyRow</span><span class="hl-4">}</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">List</span><br/><span class="hl-1"> </span><span class="hl-8">columns</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">columns</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">handler</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">fetchContacts</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;/</span><span class="hl-7">ListSlotFactory</span><span class="hl-6">&gt;</span><br/><span class="hl-1">);</span>
155
+ </code><button type="button">Copy</button></pre>
156
+
157
+ <blockquote>
158
+ <p><strong>Note:</strong> Slot overrides for <code>&lt;List /&gt;</code> follow the same merge-with-outer-factory rule as <code>OneSlotFactory</code>.</p>
159
+ </blockquote>
160
+ <a id="using-a-pre-built-theme" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Using a pre-built theme<a href="#using-a-pre-built-theme" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>If your goal is a visual redesign rather than custom business logic, <code>react-declarative-mantine</code> provides a complete <code>&lt;OneSlotFactory /&gt;</code> with all fields rebuilt using <a href="https://mantine.dev/">Mantine</a> components. Install it and wrap your app—your JSON schemas work without any changes.</p>
161
+ <pre><code class="bash"><span class="hl-5">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">react-declarative-mantine</span>
162
+ </code><button type="button">Copy</button></pre>
163
+
164
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">MantineSlotFactory</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative-mantine&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">One</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">App</span><span class="hl-1"> = () </span><span class="hl-4">=&gt;</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">MantineSlotFactory</span><span class="hl-6">&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">One</span><span class="hl-1"> </span><span class="hl-8">fields</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">fields</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-8">handler</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">handler</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;/</span><span class="hl-7">MantineSlotFactory</span><span class="hl-6">&gt;</span><br/><span class="hl-1">);</span>
165
+ </code><button type="button">Copy</button></pre>
166
+
167
+ <blockquote>
168
+ <p><strong>Tip:</strong> Preview the Mantine theme at <a href="https://react-declarative-mantine.github.io/">react-declarative-mantine.github.io</a> before installing.</p>
169
+ </blockquote>
170
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#customizing-field-renderers-with-slotfactory"><span>Customizing field renderers with <wbr/>Slot<wbr/>Factory</span></a><ul><li><a href="#oneslotfactory"><span>One<wbr/>Slot<wbr/>Factory</span></a></li><li><ul><li><a href="#available-slots"><span>Available slots</span></a></li><li><a href="#writing-a-custom-slot"><span>Writing a custom slot</span></a></li><li><a href="#common-slot-props"><span>Common slot props</span></a></li></ul></li><li><a href="#listslotfactory"><span>List<wbr/>Slot<wbr/>Factory</span></a></li><li><a href="#using-a-pre-built-theme"><span>Using a pre-<wbr/>built theme</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
documents/docs_api_components_kanban-view.html ADDED
@@ -0,0 +1,113 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>docs/api/components/kanban-view | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="docs_api_components_kanban-view.html">docs/api/components/kanban-view</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="kanbanview-props-columns-items-and-row-definition" class="tsd-anchor"></a><h1 class="tsd-anchor-link">KanbanView props: columns, items, and row definition<a href="#kanbanview-props-columns-items-and-row-definition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>KanbanView</code> renders a horizontal kanban board made up of typed columns. Each column displays a virtualised list of cards drawn from the <code>items</code> array. Users can drag cards between columns; the component fires <code>onChangeColumn</code> so you can persist the move. Card content is declarative: each column carries a <code>rows</code> array that describes what data to show on every card in that column, and the <code>value</code> function on each row is called per-card to asynchronously compute the displayed text or node.</p>
2
+ <p>The component is generic over <code>Data</code> (the shape of each item's data object), <code>Payload</code> (context forwarded to row callbacks), and <code>ColumnType</code> (the value used to identify columns, defaults to <code>IAnything</code>).</p>
3
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">KanbanView</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">type</span><span class="hl-1"> </span><span class="hl-7">Status</span><span class="hl-1"> = </span><span class="hl-3">&quot;todo&quot;</span><span class="hl-1"> | </span><span class="hl-3">&quot;in-progress&quot;</span><span class="hl-1"> | </span><span class="hl-3">&quot;done&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">ITask</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">id</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">title</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">assignee</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">column</span><span class="hl-1">: </span><span class="hl-7">Status</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">data</span><span class="hl-1">: { </span><span class="hl-2">title</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">; </span><span class="hl-2">assignee</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1"> };</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">columns</span><span class="hl-1"> = [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">column:</span><span class="hl-1"> </span><span class="hl-3">&quot;todo&quot;</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1"> </span><span class="hl-7">Status</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">label:</span><span class="hl-1"> </span><span class="hl-3">&quot;To Do&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">color:</span><span class="hl-1"> </span><span class="hl-3">&quot;#e3f2fd&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">rows:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">label:</span><span class="hl-1"> </span><span class="hl-3">&quot;Title&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">value</span><span class="hl-2">:</span><span class="hl-1"> (</span><span class="hl-2">_id</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">title</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">label:</span><span class="hl-1"> </span><span class="hl-3">&quot;Assignee&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">value</span><span class="hl-2">:</span><span class="hl-1"> (</span><span class="hl-2">_id</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">assignee</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-2">column:</span><span class="hl-1"> </span><span class="hl-3">&quot;in-progress&quot;</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1"> </span><span class="hl-7">Status</span><span class="hl-1">, </span><span class="hl-2">label:</span><span class="hl-1"> </span><span class="hl-3">&quot;In Progress&quot;</span><span class="hl-1">, </span><span class="hl-2">color:</span><span class="hl-1"> </span><span class="hl-3">&quot;#fff3e0&quot;</span><span class="hl-1">, </span><span class="hl-2">rows:</span><span class="hl-1"> [] },</span><br/><span class="hl-1"> { </span><span class="hl-2">column:</span><span class="hl-1"> </span><span class="hl-3">&quot;done&quot;</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1"> </span><span class="hl-7">Status</span><span class="hl-1">, </span><span class="hl-2">label:</span><span class="hl-1"> </span><span class="hl-3">&quot;Done&quot;</span><span class="hl-1">, </span><span class="hl-2">color:</span><span class="hl-1"> </span><span class="hl-3">&quot;#e8f5e9&quot;</span><span class="hl-1">, </span><span class="hl-2">rows:</span><span class="hl-1"> [] },</span><br/><span class="hl-1">];</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-0">default</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">TaskBoard</span><span class="hl-1">({ </span><span class="hl-2">tasks</span><span class="hl-1"> }: { </span><span class="hl-2">tasks</span><span class="hl-1">: </span><span class="hl-7">ITask</span><span class="hl-1">[] }) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">KanbanView</span><br/><span class="hl-1"> </span><span class="hl-8">columns</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">columns</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">items</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">tasks</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">onChangeColumn</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-9">(</span><span class="hl-2">id</span><span class="hl-9">, </span><span class="hl-2">newColumn</span><span class="hl-9">, </span><span class="hl-2">data</span><span class="hl-9">, </span><span class="hl-2">payload</span><span class="hl-9">) </span><span class="hl-4">=&gt;</span><span class="hl-9"> {</span><br/><span class="hl-9"> </span><span class="hl-2">console</span><span class="hl-9">.</span><span class="hl-5">log</span><span class="hl-9">(</span><span class="hl-3">`Card </span><span class="hl-4">${</span><span class="hl-2">id</span><span class="hl-4">}</span><span class="hl-3"> moved to </span><span class="hl-4">${</span><span class="hl-2">newColumn</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-9">);</span><br/><span class="hl-9"> }</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1"> );</span><br/><span class="hl-1">}</span>
4
+ </code><button type="button">Copy</button></pre>
5
+
6
+ <a id="data" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Data<a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>items</code></strong> <code>IBoardItem&lt;Data, Payload, ColumnType&gt;[]</code> <em>(required)</em></p>
7
+ <p>The flat array of all kanban cards. Each item must have an <code>id</code> string and a <code>column</code> value matching one of the column identifiers in <code>columns</code>. <code>KanbanView</code> partitions this array by column on each render.</p>
8
+ <p><strong><code>columns</code></strong> <code>IBoardColumn&lt;Data, Payload, ColumnType&gt;[]</code> <em>(required)</em></p>
9
+ <p>Column definitions. Each entry is either an <code>IBoardColumnInternal</code> (a real column with cards) or an <code>IBoardDivider</code> (a visual spacer between column groups). See the <a href="#ibboardcolumn-shape">IBoardColumn shape</a> section for details.</p>
10
+ <p><strong><code>payload</code></strong> <code>Payload | (() =&gt; Payload)</code></p>
11
+ <p>Context object forwarded to every <code>value</code>, <code>visible</code>, and <code>click</code> function on <code>IBoardRow</code>. Use it to pass user data, permissions, or API clients.</p>
12
+ <a id="iboarditem-shape" class="tsd-anchor"></a><h2 class="tsd-anchor-link"><code>IBoardItem</code> shape<a href="#iboarditem-shape" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Each element in the <code>items</code> array must conform to this interface.</p>
13
+ <p><strong><code>id</code></strong> <code>string</code> <em>(required)</em></p>
14
+ <p>Unique identifier for the card. Used as the React key and passed to all row callback functions.</p>
15
+ <p><strong><code>column</code></strong> <code>ColumnType</code> <em>(required)</em></p>
16
+ <p>The current column this card belongs to. Must match the <code>column</code> field of one of your <code>IBoardColumn</code> entries.</p>
17
+ <p><strong><code>data</code></strong> <code>Data</code> <em>(required)</em></p>
18
+ <p>The payload object for this card. Passed as the second argument to all <code>IBoardRow</code> callback functions.</p>
19
+ <p><strong><code>label</code></strong> <code>React.ReactNode | ((id: string, data: Data, payload: Payload) =&gt; React.ReactNode | Promise&lt;React.ReactNode&gt;)</code></p>
20
+ <p>Card header label. Can be a static node or an async function. If omitted, falls back to the board-level <code>cardLabel</code> prop.</p>
21
+ <p><strong><code>updatedAt</code></strong> <code>string</code></p>
22
+ <p>ISO 8601 timestamp. When <code>withUpdateOrder</code> is enabled, cards are sorted by this field in descending order (most recently updated first).</p>
23
+ <a id="iboardcolumn-shape" class="tsd-anchor"></a><h2 class="tsd-anchor-link"><code>IBoardColumn</code> shape<a href="#iboardcolumn-shape" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>column</code></strong> <code>ColumnType</code> <em>(required)</em></p>
24
+ <p>Unique identifier for this column. Cards whose <code>column</code> field equals this value are rendered here.</p>
25
+ <p><strong><code>label</code></strong> <code>string</code></p>
26
+ <p>Column header label shown above the card list.</p>
27
+ <p><strong><code>color</code></strong> <code>string</code></p>
28
+ <p>Background color of the column body and the small color dot in the header. Any valid CSS color string. Defaults to a theme-aware neutral tone.</p>
29
+ <p><strong><code>rows</code></strong> <code>IBoardRow&lt;Data, Payload&gt;[]</code> <em>(required)</em></p>
30
+ <p>Declarative row definitions that describe what data to render inside each card belonging to this column. Each row produces one labeled data line on the card.</p>
31
+ <a id="iboardrow-shape" class="tsd-anchor"></a><h2 class="tsd-anchor-link"><code>IBoardRow</code> shape<a href="#iboardrow-shape" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>label</code></strong> <code>React.ReactNode</code> <em>(required)</em></p>
32
+ <p>The field label displayed to the left of the value on the card.</p>
33
+ <p><strong><code>value</code></strong> <code>(id: string, data: Data, payload: Payload) =&gt; React.ReactNode | Promise&lt;React.ReactNode&gt;</code> <em>(required)</em></p>
34
+ <p>Async function that computes the displayed value for this row. Results are cached with a TTL controlled by <code>rowTtl</code>.</p>
35
+ <p><strong><code>visible</code></strong> <code>boolean | ((id: string, data: Data, payload: Payload) =&gt; boolean | Promise&lt;boolean&gt;)</code></p>
36
+ <p>Controls whether this row is rendered on the card. Omit or set to <code>true</code> to always show the row. When a function is provided it is evaluated async and the row is hidden until it resolves <code>true</code>.</p>
37
+ <p><strong><code>click</code></strong> <code>(id: string, data: Data, payload: Payload) =&gt; void | Promise&lt;void&gt;</code></p>
38
+ <p>Called when the user clicks this specific row's value on the card.</p>
39
+ <a id="callbacks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Callbacks<a href="#callbacks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>onChangeColumn</code></strong> <code>(id: string, column: ColumnType, data: Data, payload: IAnything) =&gt; void | Promise&lt;void&gt;</code></p>
40
+ <p>Called after a card is successfully dragged to a new column. <code>id</code> is the card's identifier; <code>column</code> is the target column. This is where you persist the status change to your backend.</p>
41
+ <p><strong><code>onCardLabelClick</code></strong> <code>(id: string, data: Data, payload: IAnything) =&gt; void</code></p>
42
+ <p>Called when the user clicks the card's header label.</p>
43
+ <p><strong><code>onDataRequest</code></strong> <code>(initial: boolean) =&gt; void</code></p>
44
+ <p>Called on mount (<code>initial = true</code>) and whenever the page becomes visible again (<code>initial = false</code>). Use it to trigger a data refresh from your parent component.</p>
45
+ <p><strong><code>onLoadStart</code></strong> <code>() =&gt; void</code></p>
46
+ <p>Called when an async row value computation begins.</p>
47
+ <p><strong><code>onLoadEnd</code></strong> <code>(isOk: boolean) =&gt; void</code></p>
48
+ <p>Called when an async row value computation completes. <code>isOk</code> is <code>false</code> if it threw.</p>
49
+ <p><strong><code>fallback</code></strong> <code>(e: Error) =&gt; void</code></p>
50
+ <p>Error handler invoked when an async row callback rejects.</p>
51
+ <p><strong><code>filterFn</code></strong> <code>(item: IBoardItem&lt;Data, Payload, ColumnType&gt;) =&gt; boolean</code></p>
52
+ <p>Client-side predicate applied to <code>items</code> before partitioning into columns. Cards that return <code>false</code> are never rendered.</p>
53
+ <a id="slot-components" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Slot components<a href="#slot-components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>AfterCardContent</code></strong> <code>React.ComponentType&lt;{ id: string; data: Data; payload: IAnything }&gt;</code></p>
54
+ <p>Custom content rendered below the declarative rows inside every card.</p>
55
+ <p><strong><code>BeforeColumnTitle</code></strong> <code>React.ComponentType&lt;{ column: ColumnType; payload: IAnything }&gt;</code></p>
56
+ <p>Custom content rendered to the left of the column header title.</p>
57
+ <p><strong><code>AfterColumnTitle</code></strong> <code>React.ComponentType&lt;{ column: ColumnType; payload: IAnything }&gt;</code></p>
58
+ <p>Custom content rendered to the right of the column header title (e.g. a card count badge).</p>
59
+ <a id="layout-and-performance" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Layout and performance<a href="#layout-and-performance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>sx</code></strong> <code>SxProps</code></p>
60
+ <p>MUI <code>sx</code> prop applied to the root container.</p>
61
+ <p><strong><code>style</code></strong> <code>React.CSSProperties</code></p>
62
+ <p>Inline styles applied to the root container.</p>
63
+ <p><strong><code>className</code></strong> <code>string</code></p>
64
+ <p>CSS class applied to the root container.</p>
65
+ <p><strong><code>bufferSize</code></strong> <code>number</code></p>
66
+ <p>Number of extra cards rendered outside the visible viewport by the internal virtual list. Increase this value if you see blank cards during fast scrolling. Defaults to <code>15</code>.</p>
67
+ <p><strong><code>minRowHeight</code></strong> <code>number</code></p>
68
+ <p>Minimum card height in pixels used by the virtual list to calculate scroll positions. Defaults to <code>125</code>.</p>
69
+ <p><strong><code>rowTtl</code></strong> <code>number</code></p>
70
+ <p>Time-to-live in milliseconds for the async <code>value</code> and <code>label</code> result cache. After this duration, the next render triggers a fresh call. Defaults to <code>500</code>.</p>
71
+ <p><strong><code>cardLabel</code></strong> <code>React.ReactNode | ((id: string, data: Data, payload: Payload) =&gt; React.ReactNode | Promise&lt;React.ReactNode&gt;)</code></p>
72
+ <p>Default card header label used when an individual item does not specify its own <code>label</code>. Can be a static node or an async function receiving <code>(id, data, payload)</code>.</p>
73
+ <a id="flags" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Flags<a href="#flags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>withGoBack</code></strong> <code>boolean</code></p>
74
+ <p>When <code>true</code>, cards can be dragged to a column that appears earlier in the <code>columns</code> array (i.e. &quot;backwards&quot; in the workflow). Defaults to <code>false</code>.</p>
75
+ <p><strong><code>withUpdateOrder</code></strong> <code>boolean</code></p>
76
+ <p>When <code>true</code>, cards within each column are sorted by <code>updatedAt</code> in descending order — most recently updated cards appear at the top.</p>
77
+ <p><strong><code>withHeaderTooltip</code></strong> <code>boolean</code></p>
78
+ <p>When <code>true</code>, a tooltip is shown on column headers, useful when the label is truncated.</p>
79
+ <p><strong><code>disabled</code></strong> <code>boolean</code></p>
80
+ <p>When <code>true</code>, all drag interactions are disabled and the board is read-only.</p>
81
+ <p><strong><code>deps</code></strong> <code>any[]</code></p>
82
+ <p>Dependency array. Changing any value clears the row cache and triggers a re-partition of <code>items</code>.</p>
83
+ <p><strong><code>reloadSubject</code></strong> <code>TSubject&lt;void&gt;</code></p>
84
+ <p>Emit on this subject to clear the row and label caches and force all cards to re-evaluate their <code>value</code> functions.</p>
85
+ <a id="static-helper" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Static helper<a href="#static-helper" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>KanbanView.enableScrollOnDrag(ref, options?)</code> is a static utility you can attach as a <code>useEffect</code> to enable auto-scroll while dragging near the left or right edges of the board.</p>
86
+ <pre><code class="tsx"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">boardRef</span><span class="hl-1"> = </span><span class="hl-5">useRef</span><span class="hl-1">&lt;</span><span class="hl-7">HTMLDivElement</span><span class="hl-1">&gt;();</span><br/><br/><span class="hl-5">useEffect</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">KanbanView</span><span class="hl-1">.</span><span class="hl-5">enableScrollOnDrag</span><span class="hl-1">(</span><span class="hl-2">boardRef</span><span class="hl-1">, { </span><span class="hl-2">threshold:</span><span class="hl-1"> </span><span class="hl-16">200</span><span class="hl-1">, </span><span class="hl-2">speed:</span><span class="hl-1"> </span><span class="hl-16">15</span><span class="hl-1"> }),</span><br/><span class="hl-1"> []</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">KanbanView</span><span class="hl-1"> </span><span class="hl-8">ref</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-2">boardRef</span><span class="hl-4">}</span><span class="hl-1"> </span><span class="hl-19">...</span><span class="hl-1"> </span><span class="hl-6">/&gt;</span><span class="hl-1">;</span>
87
+ </code><button type="button">Copy</button></pre>
88
+
89
+ <table>
90
+ <thead>
91
+ <tr>
92
+ <th>Option</th>
93
+ <th>Type</th>
94
+ <th>Default</th>
95
+ <th>Description</th>
96
+ </tr>
97
+ </thead>
98
+ <tbody>
99
+ <tr>
100
+ <td><code>threshold</code></td>
101
+ <td><code>number</code></td>
102
+ <td><code>200</code></td>
103
+ <td>Pixel distance from the edge that triggers auto-scroll.</td>
104
+ </tr>
105
+ <tr>
106
+ <td><code>speed</code></td>
107
+ <td><code>number</code></td>
108
+ <td><code>15</code></td>
109
+ <td>Pixels scrolled per interval tick.</td>
110
+ </tr>
111
+ </tbody>
112
+ </table>
113
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#kanbanview-props-columns-items-and-row-definition"><span>Kanban<wbr/>View props: columns, items, and row definition</span></a><ul><li><a href="#data"><span>Data</span></a></li><li><a href="#iboarditem-shape"><span>IBoard<wbr/>Item shape</span></a></li><li><a href="#iboardcolumn-shape"><span>IBoard<wbr/>Column shape</span></a></li><li><a href="#iboardrow-shape"><span>IBoard<wbr/>Row shape</span></a></li><li><a href="#callbacks"><span>Callbacks</span></a></li><li><a href="#slot-components"><span>Slot components</span></a></li><li><a href="#layout-and-performance"><span>Layout and performance</span></a></li><li><a href="#flags"><span>Flags</span></a></li><li><a href="#static-helper"><span>Static helper</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
documents/docs_api_components_list.html ADDED
@@ -0,0 +1,151 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>docs/api/components/list | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="docs_api_components_list.html">docs/api/components/list</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="list-component-props-columns-handler-actions-reference" class="tsd-anchor"></a><h1 class="tsd-anchor-link">List component props: columns, handler, actions reference<a href="#list-component-props-columns-handler-actions-reference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>List</code> is a batteries-included data grid component. You supply a <code>handler</code> function that receives the current filter state, pagination, sort model, chip toggles, and search string, then returns a page of rows. <code>List</code> handles the rest: rendering columns, paginating results, collecting filter form values via a <code>One</code>-compatible <code>filters</code> schema, and wiring up toolbar actions and per-row menus. The component is generic over <code>FilterData</code> (filter form shape), <code>RowData</code> (row object shape), and <code>Payload</code> (extra context).</p>
2
+ <pre><code class="tsx"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">List</span><span class="hl-1">, </span><span class="hl-2">FieldType</span><span class="hl-1">, </span><span class="hl-2">ColumnType</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;react-declarative&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">IFilters</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">status</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">IRow</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">id</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">name</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">status</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">createdAt</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-0">default</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">UserList</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6">&lt;</span><span class="hl-7">List</span><span class="hl-1">&lt;</span><span class="hl-7">IFilters</span><span class="hl-1">, </span><span class="hl-7">IRow</span><span class="hl-1">&gt;</span><br/><span class="hl-1"> </span><span class="hl-8">handler</span><span class="hl-1">=</span><span class="hl-4">{async</span><span class="hl-9"> (</span><span class="hl-2">filterData</span><span class="hl-9">, </span><span class="hl-2">pagination</span><span class="hl-9">, </span><span class="hl-2">sort</span><span class="hl-9">, </span><span class="hl-2">chips</span><span class="hl-9">, </span><span class="hl-2">search</span><span class="hl-9">) </span><span class="hl-4">=&gt;</span><span class="hl-9"> {</span><br/><span class="hl-9"> </span><span class="hl-4">const</span><span class="hl-9"> </span><span class="hl-10">res</span><span class="hl-9"> </span><span class="hl-1">=</span><span class="hl-9"> </span><span class="hl-0">await</span><span class="hl-9"> </span><span class="hl-5">fetch</span><span class="hl-9">(</span><br/><span class="hl-9"> </span><span class="hl-3">`/api/users?page=</span><span class="hl-4">${</span><span class="hl-2">pagination</span><span class="hl-9">.</span><span class="hl-2">offset</span><span class="hl-9"> </span><span class="hl-1">/</span><span class="hl-9"> </span><span class="hl-2">pagination</span><span class="hl-9">.</span><span class="hl-2">limit</span><span class="hl-4">}</span><span class="hl-3">&amp;q=</span><span class="hl-4">${</span><span class="hl-2">search</span><span class="hl-4">}</span><span class="hl-3">`</span><br/><span class="hl-9"> );</span><br/><span class="hl-9"> </span><span class="hl-4">const</span><span class="hl-9"> { </span><span class="hl-10">rows</span><span class="hl-9">, </span><span class="hl-10">total</span><span class="hl-9"> } </span><span class="hl-1">=</span><span class="hl-9"> </span><span class="hl-0">await</span><span class="hl-9"> </span><span class="hl-2">res</span><span class="hl-9">.</span><span class="hl-5">json</span><span class="hl-9">();</span><br/><span class="hl-9"> </span><span class="hl-0">return</span><span class="hl-9"> { </span><span class="hl-2">rows</span><span class="hl-9">, </span><span class="hl-2">total</span><span class="hl-9"> };</span><br/><span class="hl-9"> }</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">columns</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-9">[</span><br/><span class="hl-9"> { </span><span class="hl-2">type:</span><span class="hl-9"> </span><span class="hl-2">ColumnType</span><span class="hl-9">.</span><span class="hl-2">Text</span><span class="hl-9">, </span><span class="hl-2">field:</span><span class="hl-9"> </span><span class="hl-3">&quot;name&quot;</span><span class="hl-9">, </span><span class="hl-2">headerName:</span><span class="hl-9"> </span><span class="hl-3">&quot;Name&quot;</span><span class="hl-9">, </span><span class="hl-2">width:</span><span class="hl-9"> </span><span class="hl-3">&quot;auto&quot;</span><span class="hl-9"> },</span><br/><span class="hl-9"> { </span><span class="hl-2">type:</span><span class="hl-9"> </span><span class="hl-2">ColumnType</span><span class="hl-9">.</span><span class="hl-2">Text</span><span class="hl-9">, </span><span class="hl-2">field:</span><span class="hl-9"> </span><span class="hl-3">&quot;status&quot;</span><span class="hl-9">, </span><span class="hl-2">headerName:</span><span class="hl-9"> </span><span class="hl-3">&quot;Status&quot;</span><span class="hl-9">, </span><span class="hl-2">width:</span><span class="hl-9"> </span><span class="hl-3">&quot;120px&quot;</span><span class="hl-9"> },</span><br/><span class="hl-9"> { </span><span class="hl-2">type:</span><span class="hl-9"> </span><span class="hl-2">ColumnType</span><span class="hl-9">.</span><span class="hl-2">Text</span><span class="hl-9">, </span><span class="hl-2">field:</span><span class="hl-9"> </span><span class="hl-3">&quot;createdAt&quot;</span><span class="hl-9">, </span><span class="hl-2">headerName:</span><span class="hl-9"> </span><span class="hl-3">&quot;Created&quot;</span><span class="hl-9">, </span><span class="hl-2">width:</span><span class="hl-9"> </span><span class="hl-3">&quot;180px&quot;</span><span class="hl-9"> },</span><br/><span class="hl-9"> ]</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">filters</span><span class="hl-1">=</span><span class="hl-4">{</span><span class="hl-9">[</span><br/><span class="hl-9"> { </span><span class="hl-2">type:</span><span class="hl-9"> </span><span class="hl-2">FieldType</span><span class="hl-9">.</span><span class="hl-2">Text</span><span class="hl-9">, </span><span class="hl-2">name:</span><span class="hl-9"> </span><span class="hl-3">&quot;status&quot;</span><span class="hl-9">, </span><span class="hl-2">title:</span><span class="hl-9"> </span><span class="hl-3">&quot;Status&quot;</span><span class="hl-9"> },</span><br/><span class="hl-9"> ]</span><span class="hl-4">}</span><br/><span class="hl-1"> </span><span class="hl-8">withSearch</span><br/><span class="hl-1"> </span><span class="hl-6">/&gt;</span><br/><span class="hl-1"> );</span><br/><span class="hl-1">}</span>
3
+ </code><button type="button">Copy</button></pre>
4
+
5
+ <a id="data" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Data<a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>handler</code></strong> <code>ListHandler&lt;FilterData, RowData, Payload&gt;</code> (required)</p>
6
+ <p>The data-fetching function. Receives <code>(filterData, pagination, sort, chips, search, payload)</code> and must return either <code>RowData[]</code> (total assumed unknown) or <code>{ rows: RowData[], total: number | null }</code>. Can be async. You can also pass a static <code>RowData[]</code> array for client-side-only lists.</p>
7
+ <hr>
8
+ <p><strong><code>columns</code></strong> <code>IColumn&lt;FilterData, RowData, Payload&gt;[]</code> (required)</p>
9
+ <p>Column definitions. Each entry describes one visible column in the grid. See the <a href="#icolumn-fields">IColumn fields</a> section below.</p>
10
+ <hr>
11
+ <p><strong><code>filters</code></strong> <code>Field[]</code></p>
12
+ <p>Field schema (same format as <code>One</code>'s <code>fields</code> prop) used to render the filter panel. When the user submits the filter form, <code>handler</code> is re-called with the new <code>filterData</code>.</p>
13
+ <hr>
14
+ <p><strong><code>payload</code></strong> <code>Payload | (() =&gt; Payload)</code></p>
15
+ <p>Arbitrary context forwarded to <code>handler</code>, column <code>compute</code> callbacks, action visibility checks, and filter field callbacks. Use it for user identity, tenant IDs, or other cross-cutting values.</p>
16
+ <hr>
17
+ <p><strong><code>filterData</code></strong> <code>Partial&lt;FilterData&gt;</code></p>
18
+ <p>Pre-populate the filter form with specific values on first render.</p>
19
+ <hr>
20
+ <p><strong><code>selectedRows</code></strong> <code>RowId[]</code></p>
21
+ <p>Controlled selection state. Pass an array of row IDs to externally control which rows appear selected.</p>
22
+ <hr>
23
+ <p><strong><code>sortModel</code></strong> <code>IListSortItem&lt;RowData&gt;[]</code></p>
24
+ <p>Initial sort model applied when the list first renders. Each item is <code>{ field: keyof RowData, sort: 'asc' | 'desc' }</code>.</p>
25
+ <hr>
26
+ <p><strong><code>chipData</code></strong> <code>Partial&lt;Record&lt;keyof RowData, boolean&gt;&gt;</code></p>
27
+ <p>Initial enabled/disabled state of each chip toggle. Keys are <code>RowData</code> field names; values are booleans.</p>
28
+ <hr>
29
+ <p><strong><code>search</code></strong> <code>string</code></p>
30
+ <p>Pre-populate the search box with a string value on first render.</p>
31
+ <a id="columns-icolumn" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Columns (<code>IColumn</code>)<a href="#columns-icolumn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>type</code></strong> <code>ColumnType</code> (required)</p>
32
+ <p>Rendering strategy for the column. Common values: <code>ColumnType.Text</code>, <code>ColumnType.Action</code>, <code>ColumnType.CheckBox</code>, <code>ColumnType.Component</code>.</p>
33
+ <hr>
34
+ <p><strong><code>field</code></strong> <code>string</code></p>
35
+ <p>Key in <code>RowData</code> whose value this column displays. Omit when the column content is fully derived via <code>compute</code> or <code>element</code>.</p>
36
+ <hr>
37
+ <p><strong><code>headerName</code></strong> <code>string</code></p>
38
+ <p>Column header label shown in the grid header row.</p>
39
+ <hr>
40
+ <p><strong><code>width</code></strong> <code>string | ((containerWidth: number) =&gt; string | number)</code> (required)</p>
41
+ <p>Column width. Pass a CSS string such as <code>&quot;200px&quot;</code> or <code>&quot;auto&quot;</code>, or a function that receives the grid container width and returns a value.</p>
42
+ <hr>
43
+ <p><strong><code>sortable</code></strong> <code>boolean</code></p>
44
+ <p>When <code>true</code>, clicking the column header cycles through ascending / descending sort. The active sort is passed to <code>handler</code> on every re-fetch.</p>
45
+ <hr>
46
+ <p><strong><code>compute</code></strong> <code>(row: RowData &amp; { _payload: Payload }, payload: Payload) =&gt; Promise&lt;Value&gt; | Value</code></p>
47
+ <p>Derive the displayed value from the row instead of reading <code>field</code> directly. Runs for every visible row on each render. Can be async.</p>
48
+ <hr>
49
+ <p><strong><code>element</code></strong> <code>React.ComponentType&lt;RowData &amp; { _payload: Payload }&gt;</code></p>
50
+ <p>Replace the default cell renderer with your own React component. The component receives the full row object plus <code>_payload</code>.</p>
51
+ <hr>
52
+ <p><strong><code>columnMenu</code></strong> <code>IListActionOption[]</code></p>
53
+ <p>Per-column action menu items. Each item has <code>label</code>, <code>action</code>, optional <code>icon</code>, and optional <code>isVisible</code>/<code>isDisabled</code> callbacks that receive <code>selectedRows</code> and <code>payload</code>.</p>
54
+ <hr>
55
+ <p><strong><code>isVisible</code></strong> <code>(params: { filterData, pagination, sortModel, chips, search, payload }) =&gt; boolean</code></p>
56
+ <p>Conditionally hide the entire column based on the current list state. Called with the same params as <code>handler</code>.</p>
57
+ <hr>
58
+ <p><strong><code>primary</code></strong> <code>boolean</code></p>
59
+ <p>Marks the column as the primary identifier column, used for mobile layout prioritisation.</p>
60
+ <hr>
61
+ <p><strong><code>phoneHidden</code></strong> <code>boolean</code></p>
62
+ <p>When <code>true</code>, this column is hidden on phone-sized viewports.</p>
63
+ <hr>
64
+ <p><strong><code>tabletHidden</code></strong> <code>boolean</code></p>
65
+ <p>When <code>true</code>, this column is hidden on tablet-sized viewports.</p>
66
+ <a id="actions-and-operations" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Actions and operations<a href="#actions-and-operations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>actions</code></strong> <code>IListAction&lt;RowData, Payload&gt;[]</code></p>
67
+ <p>Toolbar-level action buttons rendered above the grid. Each action has a <code>type</code> (<code>ActionType</code>), optional <code>label</code>, optional <code>icon</code>, and optional <code>options</code> array for dropdown sub-actions. <code>isVisible</code> and <code>isDisabled</code> receive the current <code>selectedRows</code> and <code>payload</code>.</p>
68
+ <hr>
69
+ <p><strong><code>operations</code></strong> <code>IListOperation&lt;RowData, Payload&gt;[]</code></p>
70
+ <p>Bulk operations shown when one or more rows are selected. Rendered in the selection toolbar.</p>
71
+ <hr>
72
+ <p><strong><code>rowActions</code></strong> <code>IListRowAction[]</code></p>
73
+ <p>Per-row action menu items accessible through a context menu icon on each row. Each item specifies a <code>label</code>, <code>action</code> string, and optional visibility/disabled predicates.</p>
74
+ <hr>
75
+ <p><strong><code>chips</code></strong> <code>IListChip&lt;RowData&gt;[]</code></p>
76
+ <p>Quick-filter chip toggles rendered above the grid. Each chip has <code>name</code> (a <code>keyof RowData</code>), <code>label</code>, optional <code>color</code>, and an <code>enabled</code> default. Active chips are passed to <code>handler</code> as a <code>Record&lt;keyof RowData, boolean&gt;</code>.</p>
77
+ <a id="callbacks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Callbacks<a href="#callbacks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>onRowClick</code></strong> <code>(row: RowData, reload: (keepPagination?: boolean) =&gt; Promise&lt;void&gt;) =&gt; void</code></p>
78
+ <p>Called when the user clicks anywhere on a row. The second argument is a <code>reload</code> function you can call to refresh the list without navigating away.</p>
79
+ <hr>
80
+ <p><strong><code>onAction</code></strong> <code>(action: string, selectedRows: RowData[], reload: ReloadFn) =&gt; void</code></p>
81
+ <p>Called when a toolbar action is triggered. <code>action</code> is the string identifier from the action definition.</p>
82
+ <hr>
83
+ <p><strong><code>onRowAction</code></strong> <code>(action: string, row: RowData, reload: ReloadFn) =&gt; void</code></p>
84
+ <p>Called when a per-row action menu item is activated. <code>action</code> is the item's <code>action</code> string.</p>
85
+ <hr>
86
+ <p><strong><code>onOperation</code></strong> <code>(action: string, selectedRows: RowData[], isAll: boolean, reload: ReloadFn) =&gt; void</code></p>
87
+ <p>Called when a bulk operation is triggered. <code>isAll</code> is <code>true</code> when the user selected all rows across all pages.</p>
88
+ <hr>
89
+ <p><strong><code>onSelectedRows</code></strong> <code>(rowIds: RowId[], initialChange: boolean) =&gt; void</code></p>
90
+ <p>Called when the selection changes. <code>initialChange</code> is <code>true</code> for the event fired on mount.</p>
91
+ <hr>
92
+ <p><strong><code>onFilterChange</code></strong> <code>(data: FilterData) =&gt; void</code></p>
93
+ <p>Called whenever the filter form values change.</p>
94
+ <hr>
95
+ <p><strong><code>onSearchChange</code></strong> <code>(search: string) =&gt; void</code></p>
96
+ <p>Called whenever the search box value changes.</p>
97
+ <hr>
98
+ <p><strong><code>onSortModelChange</code></strong> <code>(sort: IListSortItem&lt;RowData&gt;[]) =&gt; void</code></p>
99
+ <p>Called when the sort model changes (e.g. the user clicks a sortable column header).</p>
100
+ <hr>
101
+ <p><strong><code>onRows</code></strong> <code>(rows: RowData[]) =&gt; void</code></p>
102
+ <p>Called after each successful data load with the full array of currently displayed rows.</p>
103
+ <hr>
104
+ <p><strong><code>fallback</code></strong> <code>(e: Error) =&gt; void</code></p>
105
+ <p>Called if <code>handler</code> rejects. Use it to display an error message.</p>
106
+ <hr>
107
+ <p><strong><code>onLoadStart</code></strong> <code>(source: string) =&gt; void</code></p>
108
+ <p>Called when a data fetch begins.</p>
109
+ <hr>
110
+ <p><strong><code>onLoadEnd</code></strong> <code>(isOk: boolean, source: string) =&gt; void</code></p>
111
+ <p>Called when a data fetch completes. <code>isOk</code> is <code>false</code> on error.</p>
112
+ <a id="flags" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Flags<a href="#flags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>withSearch</code></strong> <code>boolean</code></p>
113
+ <p>Show a search input in the toolbar. The current search string is passed to <code>handler</code> on every re-fetch.</p>
114
+ <hr>
115
+ <p><strong><code>withMobile</code></strong> <code>boolean</code></p>
116
+ <p>Enable the responsive mobile layout, which reorders and hides columns according to each column's <code>phoneOrder</code> and <code>phoneHidden</code> settings.</p>
117
+ <hr>
118
+ <p><strong><code>withArrowPagination</code></strong> <code>boolean</code></p>
119
+ <p>Replace the default page-number pagination controls with simple previous/next arrow buttons.</p>
120
+ <hr>
121
+ <p><strong><code>withRangePagination</code></strong> <code>boolean</code></p>
122
+ <p>Show a page range selector alongside the arrow controls.</p>
123
+ <hr>
124
+ <p><strong><code>withSingleSort</code></strong> <code>boolean</code></p>
125
+ <p>Restrict sorting to a single column at a time, clearing any existing sort when the user clicks a new column header.</p>
126
+ <hr>
127
+ <p><strong><code>withSelectOnRowClick</code></strong> <code>boolean</code></p>
128
+ <p>Toggle row selection when the user clicks a row body (in addition to clicking the checkbox).</p>
129
+ <hr>
130
+ <p><strong><code>withToggledFilters</code></strong> <code>boolean</code></p>
131
+ <p>Start with the filter panel collapsed. The user can expand it via a toolbar toggle button.</p>
132
+ <hr>
133
+ <p><strong><code>selectionMode</code></strong> <code>SelectionMode</code></p>
134
+ <p>Controls how rows can be selected. Typical values: <code>SelectionMode.None</code>, <code>SelectionMode.Single</code>, <code>SelectionMode.Multiple</code>.</p>
135
+ <a id="pagination-and-limits" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Pagination and limits<a href="#pagination-and-limits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>limit</code></strong> <code>number</code></p>
136
+ <p>Initial page size (number of rows per page). Defaults to the first entry in <code>rowsPerPage</code>.</p>
137
+ <hr>
138
+ <p><strong><code>page</code></strong> <code>number</code></p>
139
+ <p>Initial page index (zero-based).</p>
140
+ <hr>
141
+ <p><strong><code>rowsPerPage</code></strong> <code>Array&lt;number | { value: number; label: string }&gt;</code></p>
142
+ <p>Options shown in the rows-per-page selector. Pass plain numbers or <code>{ value, label }</code> objects for custom labels.</p>
143
+ <a id="subjects-reactive-control" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Subjects (reactive control)<a href="#subjects-reactive-control" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong><code>reloadSubject</code></strong> <code>TSubject&lt;void&gt;</code></p>
144
+ <p>Emit on this subject to trigger a fresh <code>handler</code> call programmatically without unmounting the component.</p>
145
+ <hr>
146
+ <p><strong><code>rerenderSubject</code></strong> <code>TSubject&lt;void&gt;</code></p>
147
+ <p>Emit to force a visual re-render without re-fetching data.</p>
148
+ <hr>
149
+ <p><strong><code>setFilterDataSubject</code></strong> <code>TSubject&lt;FilterData&gt;</code></p>
150
+ <p>Emit a <code>FilterData</code> object to programmatically update the filter form values and re-fetch.</p>
151
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#list-component-props-columns-handler-actions-reference"><span>List component props: columns, handler, actions reference</span></a><ul><li><a href="#data"><span>Data</span></a></li><li><a href="#columns-icolumn"><span>Columns (IColumn)</span></a></li><li><a href="#actions-and-operations"><span>Actions and operations</span></a></li><li><a href="#callbacks"><span>Callbacks</span></a></li><li><a href="#flags"><span>Flags</span></a></li><li><a href="#pagination-and-limits"><span>Pagination and limits</span></a></li><li><a href="#subjects-reactive-control"><span>Subjects (reactive control)</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>