mayoiga 0.1.2 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,783 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>&quot;mayoiga&quot; | Mayoiga</title>
7
- <meta name="description" content="">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- </head>
11
- <body>
12
- <header>
13
- <div class="tsd-page-toolbar">
14
- <div class="container">
15
- <div class="table-wrap">
16
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
- <div class="field">
18
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
- <input id="tsd-search-field" type="text" />
20
- </div>
21
- <ul class="results">
22
- <li class="state loading">Preparing search index...</li>
23
- <li class="state failure">The search index is not available</li>
24
- </ul>
25
- <a href="../index.html" class="title">Mayoiga</a>
26
- </div>
27
- <div class="table-cell" id="tsd-widgets">
28
- <div id="tsd-filter">
29
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
- <div class="tsd-filter-group">
31
- <div class="tsd-select" id="tsd-filter-visibility">
32
- <span class="tsd-select-label">All</span>
33
- <ul class="tsd-select-list">
34
- <li data-value="public">Public</li>
35
- <li data-value="protected">Public/Protected</li>
36
- <li data-value="private" class="selected">All</li>
37
- </ul>
38
- </div>
39
- <input type="checkbox" id="tsd-filter-inherited" checked />
40
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
- <input type="checkbox" id="tsd-filter-externals" checked />
42
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
- <input type="checkbox" id="tsd-filter-only-exported" />
44
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
- </div>
46
- </div>
47
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
- </div>
49
- </div>
50
- </div>
51
- </div>
52
- <div class="tsd-page-title">
53
- <div class="container">
54
- <ul class="tsd-breadcrumb">
55
- <li>
56
- <a href="../globals.html">Globals</a>
57
- </li>
58
- <li>
59
- <a href="_mayoiga_.html">&quot;mayoiga&quot;</a>
60
- </li>
61
- </ul>
62
- <h1>External module &quot;mayoiga&quot;</h1>
63
- </div>
64
- </div>
65
- </header>
66
- <div class="container container-main">
67
- <div class="row">
68
- <div class="col-8 col-content">
69
- <section class="tsd-panel-group tsd-index-group">
70
- <h2>Index</h2>
71
- <section class="tsd-panel tsd-index-panel">
72
- <div class="tsd-index-content">
73
- <section class="tsd-index-section tsd-is-not-exported">
74
- <h3>Type aliases</h3>
75
- <ul class="tsd-index-list">
76
- <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_mayoiga_.html#fieldprops" class="tsd-kind-icon">Field<wbr>Props</a></li>
77
- <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_mayoiga_.html#formprops" class="tsd-kind-icon">Form<wbr>Props</a></li>
78
- <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_mayoiga_.html#mayoigacontextvalue" class="tsd-kind-icon">Mayoiga<wbr>Context<wbr>Value</a></li>
79
- <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_mayoiga_.html#mayoigaprops" class="tsd-kind-icon">Mayoiga<wbr>Props</a></li>
80
- <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_mayoiga_.html#scopedcomponentprops" class="tsd-kind-icon">Scoped<wbr>Component<wbr>Props</a></li>
81
- <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_mayoiga_.html#validator" class="tsd-kind-icon">Validator</a></li>
82
- </ul>
83
- </section>
84
- <section class="tsd-index-section tsd-is-not-exported">
85
- <h3>Variables</h3>
86
- <ul class="tsd-index-list">
87
- <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_mayoiga_.html#empty_errors" class="tsd-kind-icon">EMPTY_<wbr>ERRORS</a></li>
88
- </ul>
89
- </section>
90
- <section class="tsd-index-section ">
91
- <h3>Functions</h3>
92
- <ul class="tsd-index-list">
93
- <li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_mayoiga_.html#createformscope" class="tsd-kind-icon">create<wbr>Form<wbr>Scope</a></li>
94
- <li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_mayoiga_.html#useform" class="tsd-kind-icon">use<wbr>Form</a></li>
95
- <li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_mayoiga_.html#useformstate" class="tsd-kind-icon">use<wbr>Form<wbr>State</a></li>
96
- </ul>
97
- </section>
98
- </div>
99
- </section>
100
- </section>
101
- <section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
102
- <h2>Type aliases</h2>
103
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
104
- <a name="fieldprops" class="tsd-anchor"></a>
105
- <h3>Field<wbr>Props</h3>
106
- <div class="tsd-signature tsd-kind-icon">Field<wbr>Props&lt;S, Name, ComponentProps&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
107
- <aside class="tsd-sources">
108
- <ul>
109
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L34">src/mayoiga.tsx:34</a></li>
110
- </ul>
111
- </aside>
112
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
113
- <ul class="tsd-type-parameters">
114
- <li>
115
- <h4>S</h4>
116
- </li>
117
- <li>
118
- <h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">keyof S</span></h4>
119
- </li>
120
- <li>
121
- <h4>ComponentProps</h4>
122
- </li>
123
- </ul>
124
- <div class="tsd-type-declaration">
125
- <h4>Type declaration</h4>
126
- <ul class="tsd-parameters">
127
- <li class="tsd-parameter">
128
- <h5>component<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><a href="_inputprotocol_.html#inputprotocol" class="tsd-signature-type">InputProtocol</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Name</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentProps</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
129
- <div class="tsd-comment tsd-typography">
130
- <div class="lead">
131
- <p>Component which can handle the field of the form state. It should implement <a href="_inputprotocol_.html#inputprotocol">InputProtocol</a>.</p>
132
- </div>
133
- </div>
134
- </li>
135
- <li class="tsd-parameter">
136
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Props<span class="tsd-signature-symbol">?: </span><a href="" class="tsd-signature-type">ComponentProps</a></h5>
137
- <div class="tsd-comment tsd-typography">
138
- <div class="lead">
139
- <p>Props to delegate to the input component.</p>
140
- </div>
141
- <dl class="tsd-comment-tags">
142
- <dt>example</dt>
143
- <dd><pre><code>
144
- <span class="hljs-attr">componentProps</span>={{disabled: props.formState.age &gt;= <span class="hljs-number">20</span>}}
145
- <span class="hljs-attr">component</span>={AlcoholCheckbox}</code></pre></dd>
146
- </dl>
147
- </div>
148
- </li>
149
- <li class="tsd-parameter">
150
- <h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Name</span></h5>
151
- <div class="tsd-comment tsd-typography">
152
- <div class="lead">
153
- <p>One on the name of field. Have to be <code>keyof State</code>.</p>
154
- </div>
155
- </div>
156
- </li>
157
- <li class="tsd-parameter">
158
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> validations<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol">&lt;</span><a href="_mayoiga_.html#validator" class="tsd-signature-type">Validator</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
159
- </li>
160
- <li class="tsd-parameter">
161
- <h5>on<wbr>Change<span class="tsd-signature-symbol">: </span>function</h5>
162
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
163
- <li class="tsd-signature tsd-kind-icon">on<wbr>Change<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Name</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S[Name]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
164
- </ul>
165
- <ul class="tsd-descriptions">
166
- <li class="tsd-description">
167
- <aside class="tsd-sources">
168
- <ul>
169
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L38">src/mayoiga.tsx:38</a></li>
170
- </ul>
171
- </aside>
172
- <div class="tsd-comment tsd-typography">
173
- <div class="lead">
174
- <p>You might want to handle onChange event in case.</p>
175
- </div>
176
- </div>
177
- <h4 class="tsd-parameters-title">Parameters</h4>
178
- <ul class="tsd-parameters">
179
- <li>
180
- <h5>name: <span class="tsd-signature-type">Name</span></h5>
181
- </li>
182
- <li>
183
- <h5>value: <span class="tsd-signature-type">S[Name]</span></h5>
184
- </li>
185
- </ul>
186
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
187
- </li>
188
- </ul> </li>
189
- </ul>
190
- </div>
191
- </section>
192
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
193
- <a name="formprops" class="tsd-anchor"></a>
194
- <h3>Form<wbr>Props</h3>
195
- <div class="tsd-signature tsd-kind-icon">Form<wbr>Props&lt;S&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
196
- <aside class="tsd-sources">
197
- <ul>
198
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L26">src/mayoiga.tsx:26</a></li>
199
- </ul>
200
- </aside>
201
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
202
- <ul class="tsd-type-parameters">
203
- <li>
204
- <h4>S</h4>
205
- </li>
206
- </ul>
207
- <div class="tsd-type-declaration">
208
- <h4>Type declaration</h4>
209
- <ul class="tsd-parameters">
210
- <li class="tsd-parameter">
211
- <h5>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span></h5>
212
- </li>
213
- <li class="tsd-parameter">
214
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> class<wbr>Name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
215
- </li>
216
- <li class="tsd-parameter">
217
- <h5>on<wbr>Submit<span class="tsd-signature-symbol">: </span>function</h5>
218
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
219
- <li class="tsd-signature tsd-kind-icon">on<wbr>Submit<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
220
- </ul>
221
- <ul class="tsd-descriptions">
222
- <li class="tsd-description">
223
- <aside class="tsd-sources">
224
- <ul>
225
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L28">src/mayoiga.tsx:28</a></li>
226
- </ul>
227
- </aside>
228
- <h4 class="tsd-parameters-title">Parameters</h4>
229
- <ul class="tsd-parameters">
230
- <li>
231
- <h5>value: <span class="tsd-signature-type">S</span></h5>
232
- </li>
233
- </ul>
234
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
235
- </li>
236
- </ul> </li>
237
- </ul>
238
- </div>
239
- </section>
240
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
241
- <a name="mayoigacontextvalue" class="tsd-anchor"></a>
242
- <h3>Mayoiga<wbr>Context<wbr>Value</h3>
243
- <div class="tsd-signature tsd-kind-icon">Mayoiga<wbr>Context<wbr>Value&lt;S&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
244
- <aside class="tsd-sources">
245
- <ul>
246
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L12">src/mayoiga.tsx:12</a></li>
247
- </ul>
248
- </aside>
249
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
250
- <ul class="tsd-type-parameters">
251
- <li>
252
- <h4>S</h4>
253
- </li>
254
- </ul>
255
- <div class="tsd-type-declaration">
256
- <h4>Type declaration</h4>
257
- <ul class="tsd-parameters">
258
- <li class="tsd-parameter">
259
- <h5>dispatch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Dispatch</span><span class="tsd-signature-symbol">&lt;</span><a href="_actions_.html#fsa" class="tsd-signature-type">FSA</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
260
- </li>
261
- <li class="tsd-parameter">
262
- <h5>state<span class="tsd-signature-symbol">: </span><a href="_reducer_.html#store" class="tsd-signature-type">Store</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span></h5>
263
- </li>
264
- </ul>
265
- </div>
266
- </section>
267
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
268
- <a name="mayoigaprops" class="tsd-anchor"></a>
269
- <h3>Mayoiga<wbr>Props</h3>
270
- <div class="tsd-signature tsd-kind-icon">Mayoiga<wbr>Props&lt;S&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
271
- <aside class="tsd-sources">
272
- <ul>
273
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L55">src/mayoiga.tsx:55</a></li>
274
- </ul>
275
- </aside>
276
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
277
- <ul class="tsd-type-parameters">
278
- <li>
279
- <h4>S</h4>
280
- </li>
281
- </ul>
282
- <div class="tsd-type-declaration">
283
- <h4>Type declaration</h4>
284
- <ul class="tsd-parameters">
285
- <li class="tsd-parameter">
286
- <h5>initial<wbr>State<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span></h5>
287
- </li>
288
- <li class="tsd-parameter">
289
- <h5>on<wbr>Submit<span class="tsd-signature-symbol">: </span>function</h5>
290
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
291
- <li class="tsd-signature tsd-kind-icon">on<wbr>Submit<span class="tsd-signature-symbol">(</span>hasErrors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, formInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
292
- </ul>
293
- <ul class="tsd-descriptions">
294
- <li class="tsd-description">
295
- <aside class="tsd-sources">
296
- <ul>
297
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L57">src/mayoiga.tsx:57</a></li>
298
- </ul>
299
- </aside>
300
- <h4 class="tsd-parameters-title">Parameters</h4>
301
- <ul class="tsd-parameters">
302
- <li>
303
- <h5>hasErrors: <span class="tsd-signature-type">boolean</span></h5>
304
- </li>
305
- <li>
306
- <h5>value: <span class="tsd-signature-type">S</span></h5>
307
- </li>
308
- <li>
309
- <h5>formInfo: <span class="tsd-signature-type">object</span></h5>
310
- <ul class="tsd-parameters">
311
- <li class="tsd-parameter">
312
- <h5>errors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5>
313
- <ul class="tsd-parameters">
314
- </ul>
315
- </li>
316
- <li class="tsd-parameter">
317
- <h5>touched<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
318
- </li>
319
- </ul>
320
- </li>
321
- </ul>
322
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
323
- </li>
324
- </ul> </li>
325
- </ul>
326
- </div>
327
- </section>
328
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
329
- <a name="scopedcomponentprops" class="tsd-anchor"></a>
330
- <h3>Scoped<wbr>Component<wbr>Props</h3>
331
- <div class="tsd-signature tsd-kind-icon">Scoped<wbr>Component<wbr>Props&lt;S&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
332
- <aside class="tsd-sources">
333
- <ul>
334
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L61">src/mayoiga.tsx:61</a></li>
335
- </ul>
336
- </aside>
337
- <div class="tsd-comment tsd-typography">
338
- <dl class="tsd-comment-tags">
339
- <dt>obsolete</dt>
340
- <dd></dd>
341
- </dl>
342
- </div>
343
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
344
- <ul class="tsd-type-parameters">
345
- <li>
346
- <h4>S</h4>
347
- </li>
348
- </ul>
349
- <div class="tsd-type-declaration">
350
- <h4>Type declaration</h4>
351
- <ul class="tsd-parameters">
352
- <li class="tsd-parameter">
353
- <h5>errors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5>
354
- <ul class="tsd-parameters">
355
- </ul>
356
- </li>
357
- <li class="tsd-parameter">
358
- <h5>form<wbr>State<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span></h5>
359
- </li>
360
- <li class="tsd-parameter">
361
- <h5>touched<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
362
- </li>
363
- </ul>
364
- </div>
365
- </section>
366
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
367
- <a name="validator" class="tsd-anchor"></a>
368
- <h3>Validator</h3>
369
- <div class="tsd-signature tsd-kind-icon">Validator&lt;S, Name&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
370
- <aside class="tsd-sources">
371
- <ul>
372
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L24">src/mayoiga.tsx:24</a></li>
373
- </ul>
374
- </aside>
375
- <div class="tsd-comment tsd-typography">
376
- <div class="lead">
377
- <p>Validator definition to pass to the each form fields.</p>
378
- </div>
379
- <dl class="tsd-comment-tags">
380
- <dt>param</dt>
381
- <dd><p>The value which handled by the input field.</p>
382
- </dd>
383
- <dt>param</dt>
384
- <dd><p>The form state itselfs. It is useful if you had to write validation depends on other fields.</p>
385
- </dd>
386
- <dt>returns</dt>
387
- <dd><p>It should return string if there is something wrong.</p>
388
- </dd>
389
- </dl>
390
- </div>
391
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
392
- <ul class="tsd-type-parameters">
393
- <li>
394
- <h4>S</h4>
395
- </li>
396
- <li>
397
- <h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">keyof S</span></h4>
398
- </li>
399
- </ul>
400
- <div class="tsd-type-declaration">
401
- <h4>Type declaration</h4>
402
- <ul class="tsd-parameters">
403
- <li class="tsd-parameter-siganture">
404
- <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
405
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S[Name]</span>, record<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</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><span class="tsd-signature-type">string</span></li>
406
- </ul>
407
- <ul class="tsd-descriptions">
408
- <li class="tsd-description">
409
- <h4 class="tsd-parameters-title">Parameters</h4>
410
- <ul class="tsd-parameters">
411
- <li>
412
- <h5>target: <span class="tsd-signature-type">S[Name]</span></h5>
413
- </li>
414
- <li>
415
- <h5>record: <span class="tsd-signature-type">S</span></h5>
416
- </li>
417
- </ul>
418
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span>
419
- <span class="tsd-signature-symbol"> | </span>
420
- <span class="tsd-signature-type">string</span>
421
- </h4>
422
- </li>
423
- </ul>
424
- </li>
425
- </ul>
426
- </div>
427
- </section>
428
- </section>
429
- <section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
430
- <h2>Variables</h2>
431
- <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
432
- <a name="empty_errors" class="tsd-anchor"></a>
433
- <h3><span class="tsd-flag ts-flagConst">Const</span> EMPTY_<wbr>ERRORS</h3>
434
- <div class="tsd-signature tsd-kind-icon">EMPTY_<wbr>ERRORS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
435
- <aside class="tsd-sources">
436
- <ul>
437
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L10">src/mayoiga.tsx:10</a></li>
438
- </ul>
439
- </aside>
440
- </section>
441
- </section>
442
- <section class="tsd-panel-group tsd-member-group ">
443
- <h2>Functions</h2>
444
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
445
- <a name="createformscope" class="tsd-anchor"></a>
446
- <h3>create<wbr>Form<wbr>Scope</h3>
447
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
448
- <li class="tsd-signature tsd-kind-icon">create<wbr>Form<wbr>Scope&lt;S&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
449
- </ul>
450
- <ul class="tsd-descriptions">
451
- <li class="tsd-description">
452
- <aside class="tsd-sources">
453
- <ul>
454
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L83">src/mayoiga.tsx:83</a></li>
455
- </ul>
456
- </aside>
457
- <div class="tsd-comment tsd-typography">
458
- <div class="lead">
459
- <p>A function to create scope which allows to use <code>useForm</code> function to manage form value.</p>
460
- </div>
461
- <dl class="tsd-comment-tags">
462
- <dt>example</dt>
463
- <dd><pre><code>
464
- <span class="hljs-keyword">type</span> FormState = {name: <span class="hljs-string">''</span>, age: <span class="hljs-number">0</span>};
465
- <span class="hljs-keyword">const</span> {context, scope} = createFormScope&lt;FormState&gt;();
466
-
467
- <span class="hljs-keyword">const</span> TheForm = scope(<span class="hljs-function"><span class="hljs-params">props</span> =&gt;</span> {
468
- <span class="hljs-keyword">const</span> {Form, Field} = useForm(context);
469
- <span class="hljs-comment">// ...</span></code></pre></dd>
470
- </dl>
471
- </div>
472
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
473
- <ul class="tsd-type-parameters">
474
- <li>
475
- <h4>S</h4>
476
- </li>
477
- </ul>
478
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
479
- <ul class="tsd-parameters">
480
- <li class="tsd-parameter">
481
- <h5>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h5>
482
- </li>
483
- <li class="tsd-parameter">
484
- <h5>scope<span class="tsd-signature-symbol">: </span>function</h5>
485
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-has-type-parameter tsd-is-not-exported">
486
- <li class="tsd-signature tsd-kind-icon">scope&lt;OwnProps&gt;<span class="tsd-signature-symbol">(</span>ConnectedComponent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">OwnProps</span><span class="tsd-signature-symbol"> &amp; </span><a href="_mayoiga_.html#scopedcomponentprops" class="tsd-signature-type">ScopedComponentProps</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</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">(Anonymous function)</span></li>
487
- </ul>
488
- <ul class="tsd-descriptions">
489
- <li class="tsd-description">
490
- <aside class="tsd-sources">
491
- <ul>
492
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L88">src/mayoiga.tsx:88</a></li>
493
- </ul>
494
- </aside>
495
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
496
- <ul class="tsd-type-parameters">
497
- <li>
498
- <h4>OwnProps</h4>
499
- </li>
500
- </ul>
501
- <h4 class="tsd-parameters-title">Parameters</h4>
502
- <ul class="tsd-parameters">
503
- <li>
504
- <h5>ConnectedComponent: <span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">OwnProps</span><span class="tsd-signature-symbol"> &amp; </span><a href="_mayoiga_.html#scopedcomponentprops" class="tsd-signature-type">ScopedComponentProps</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
505
- </li>
506
- </ul>
507
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
508
- </li>
509
- </ul> </li>
510
- </ul>
511
- </li>
512
- </ul>
513
- </section>
514
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
515
- <a name="useform" class="tsd-anchor"></a>
516
- <h3>use<wbr>Form</h3>
517
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
518
- <li class="tsd-signature tsd-kind-icon">use<wbr>Form&lt;S&gt;<span class="tsd-signature-symbol">(</span>formScope<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol">&lt;</span><a href="_mayoiga_.html#mayoigacontextvalue" class="tsd-signature-type">MayoigaContextValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</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">object</span></li>
519
- </ul>
520
- <ul class="tsd-descriptions">
521
- <li class="tsd-description">
522
- <aside class="tsd-sources">
523
- <ul>
524
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L126">src/mayoiga.tsx:126</a></li>
525
- </ul>
526
- </aside>
527
- <div class="tsd-comment tsd-typography">
528
- <div class="lead">
529
- <p>The Hook to summon type safe React form component.
530
- To know the props that Field can accept <a href="_mayoiga_.html#fieldprops">FieldProps</a>.</p>
531
- </div>
532
- <dl class="tsd-comment-tags">
533
- <dt>example</dt>
534
- <dd><pre><code>
535
- <span class="hljs-keyword">const</span> TheForm = scope(props =&gt; {
536
- <span class="hljs-keyword">const</span> {<span class="hljs-keyword">Form</span>, Field} = useForm(context);
537
- <span class="hljs-keyword">return</span> (
538
- &lt;<span class="hljs-keyword">Form</span>&gt;
539
- &lt;Field name=<span class="hljs-string">"name"</span> component={props =&gt; &lt;<span class="hljs-keyword">input</span> value={props.value.<span class="hljs-keyword">toString</span>()} /&gt;} validations={[required]} /&gt;
540
- &lt;Field name=<span class="hljs-string">"fieldNameHaven'tDefined"</span> &lt;= you will see compile <span class="hljs-keyword">error</span> <span class="hljs-keyword">if</span> you were specified the name haven't declared <span class="hljs-keyword">in</span> the context <span class="hljs-keyword">type</span> <span class="hljs-keyword">for</span> initialState.
541
- &lt;/<span class="hljs-keyword">Form</span>&gt;
542
- );</code></pre><p>You should be aware, <code>component</code> props for <Field /> is going to be cached at the first render. So it should be same pure function.</p>
543
- </dd>
544
- </dl>
545
- </div>
546
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
547
- <ul class="tsd-type-parameters">
548
- <li>
549
- <h4>S</h4>
550
- </li>
551
- </ul>
552
- <h4 class="tsd-parameters-title">Parameters</h4>
553
- <ul class="tsd-parameters">
554
- <li>
555
- <h5>formScope: <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol">&lt;</span><a href="_mayoiga_.html#mayoigacontextvalue" class="tsd-signature-type">MayoigaContextValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
556
- </li>
557
- </ul>
558
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
559
- <ul class="tsd-parameters">
560
- <li class="tsd-parameter">
561
- <h5>Form<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NamedExoticComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></h5>
562
- </li>
563
- <li class="tsd-parameter">
564
- <h5>Field<span class="tsd-signature-symbol">: </span>function</h5>
565
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-has-type-parameter tsd-is-not-exported">
566
- <li class="tsd-signature tsd-kind-icon">Field&lt;Name, ComponentProps&gt;<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><a href="_mayoiga_.html#fieldprops" class="tsd-signature-type">FieldProps</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Name</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentProps</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">Element</span></li>
567
- </ul>
568
- <ul class="tsd-descriptions">
569
- <li class="tsd-description">
570
- <aside class="tsd-sources">
571
- <ul>
572
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L148">src/mayoiga.tsx:148</a></li>
573
- </ul>
574
- </aside>
575
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
576
- <ul class="tsd-type-parameters">
577
- <li>
578
- <h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Extract</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">keyof S</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
579
- </li>
580
- <li>
581
- <h4>ComponentProps</h4>
582
- </li>
583
- </ul>
584
- <h4 class="tsd-parameters-title">Parameters</h4>
585
- <ul class="tsd-parameters">
586
- <li>
587
- <h5>props: <a href="_mayoiga_.html#fieldprops" class="tsd-signature-type">FieldProps</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Name</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
588
- </li>
589
- </ul>
590
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4>
591
- </li>
592
- </ul> </li>
593
- <li class="tsd-parameter">
594
- <h5>use<wbr>Form<wbr>State<span class="tsd-signature-symbol">: </span>function</h5>
595
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported">
596
- <li class="tsd-signature tsd-kind-icon">use<wbr>Form<wbr>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><a href="_reducer_.html#store" class="tsd-signature-type">Store</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">]</span></li>
597
- </ul>
598
- <ul class="tsd-descriptions">
599
- <li class="tsd-description">
600
- <aside class="tsd-sources">
601
- <ul>
602
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L192">src/mayoiga.tsx:192</a></li>
603
- </ul>
604
- </aside>
605
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a href="_reducer_.html#store" class="tsd-signature-type">Store</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">]</span></h4>
606
- </li>
607
- </ul> </li>
608
- </ul>
609
- </li>
610
- </ul>
611
- </section>
612
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
613
- <a name="useformstate" class="tsd-anchor"></a>
614
- <h3>use<wbr>Form<wbr>State</h3>
615
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
616
- <li class="tsd-signature tsd-kind-icon">use<wbr>Form<wbr>State&lt;S&gt;<span class="tsd-signature-symbol">(</span>formScope<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol">&lt;</span><a href="_mayoiga_.html#mayoigacontextvalue" class="tsd-signature-type">MayoigaContextValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</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><a href="_reducer_.html#store" class="tsd-signature-type">Store</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">]</span></li>
617
- </ul>
618
- <ul class="tsd-descriptions">
619
- <li class="tsd-description">
620
- <aside class="tsd-sources">
621
- <ul>
622
- <li>Defined in <a href="https://github.com/hachibeeDI/mayoiga/blob/1ac9182/src/mayoiga.tsx#L212">src/mayoiga.tsx:212</a></li>
623
- </ul>
624
- </aside>
625
- <div class="tsd-comment tsd-typography">
626
- <div class="lead">
627
- <p>You can get current form state and also change it:</p>
628
- </div>
629
- <pre><code>const [{ errors, formData }, setFormState] = useFormState(<span class="hljs-keyword">context</span>);
630
- ...
631
- onChange={<span class="hljs-built_in">(name</span>, <span class="hljs-keyword">value</span>) =&gt; {
632
- <span class="hljs-keyword">if</span> (<span class="hljs-keyword">value</span>) setFormState({otherFieldValue: <span class="hljs-string">''</span>});
633
- }}</code></pre>
634
- </div>
635
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
636
- <ul class="tsd-type-parameters">
637
- <li>
638
- <h4>S</h4>
639
- </li>
640
- </ul>
641
- <h4 class="tsd-parameters-title">Parameters</h4>
642
- <ul class="tsd-parameters">
643
- <li>
644
- <h5>formScope: <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol">&lt;</span><a href="_mayoiga_.html#mayoigacontextvalue" class="tsd-signature-type">MayoigaContextValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
645
- </li>
646
- </ul>
647
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a href="_reducer_.html#store" class="tsd-signature-type">Store</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">]</span></h4>
648
- </li>
649
- </ul>
650
- </section>
651
- </section>
652
- </div>
653
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
654
- <nav class="tsd-navigation primary">
655
- <ul>
656
- <li class="globals ">
657
- <a href="../globals.html"><em>Globals</em></a>
658
- </li>
659
- <li class=" tsd-kind-external-module">
660
- <a href="_actions_.html">&quot;actions&quot;</a>
661
- </li>
662
- <li class=" tsd-kind-external-module">
663
- <a href="_forms_.html">&quot;forms&quot;</a>
664
- </li>
665
- <li class=" tsd-kind-external-module">
666
- <a href="_index_.html">&quot;index&quot;</a>
667
- </li>
668
- <li class=" tsd-kind-external-module">
669
- <a href="_inputprotocol_.html">&quot;input<wbr>Protocol&quot;</a>
670
- </li>
671
- <li class="current tsd-kind-external-module">
672
- <a href="_mayoiga_.html">&quot;mayoiga&quot;</a>
673
- </li>
674
- <li class=" tsd-kind-external-module">
675
- <a href="_reducer_.html">&quot;reducer&quot;</a>
676
- </li>
677
- </ul>
678
- </nav>
679
- <nav class="tsd-navigation secondary menu-sticky">
680
- <ul class="before-current">
681
- <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
682
- <a href="_mayoiga_.html#fieldprops" class="tsd-kind-icon">Field<wbr>Props</a>
683
- </li>
684
- <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
685
- <a href="_mayoiga_.html#formprops" class="tsd-kind-icon">Form<wbr>Props</a>
686
- </li>
687
- <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
688
- <a href="_mayoiga_.html#mayoigacontextvalue" class="tsd-kind-icon">Mayoiga<wbr>Context<wbr>Value</a>
689
- </li>
690
- <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
691
- <a href="_mayoiga_.html#mayoigaprops" class="tsd-kind-icon">Mayoiga<wbr>Props</a>
692
- </li>
693
- <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
694
- <a href="_mayoiga_.html#scopedcomponentprops" class="tsd-kind-icon">Scoped<wbr>Component<wbr>Props</a>
695
- </li>
696
- <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
697
- <a href="_mayoiga_.html#validator" class="tsd-kind-icon">Validator</a>
698
- </li>
699
- <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
700
- <a href="_mayoiga_.html#empty_errors" class="tsd-kind-icon">EMPTY_<wbr>ERRORS</a>
701
- </li>
702
- <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
703
- <a href="_mayoiga_.html#createformscope" class="tsd-kind-icon">create<wbr>Form<wbr>Scope</a>
704
- </li>
705
- <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
706
- <a href="_mayoiga_.html#useform" class="tsd-kind-icon">use<wbr>Form</a>
707
- </li>
708
- <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
709
- <a href="_mayoiga_.html#useformstate" class="tsd-kind-icon">use<wbr>Form<wbr>State</a>
710
- </li>
711
- </ul>
712
- </nav>
713
- </div>
714
- </div>
715
- </div>
716
- <footer class="with-border-bottom">
717
- <div class="container">
718
- <h2>Legend</h2>
719
- <div class="tsd-legend-group">
720
- <ul class="tsd-legend">
721
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
722
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
723
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
724
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
725
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
726
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
727
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
728
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
729
- </ul>
730
- <ul class="tsd-legend">
731
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
732
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
733
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
734
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
735
- </ul>
736
- <ul class="tsd-legend">
737
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
738
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
739
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
740
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
741
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
742
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
743
- </ul>
744
- <ul class="tsd-legend">
745
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
746
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
747
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
748
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
749
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
750
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
751
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
752
- </ul>
753
- <ul class="tsd-legend">
754
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
755
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
756
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
757
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
758
- </ul>
759
- <ul class="tsd-legend">
760
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
761
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
762
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
763
- </ul>
764
- <ul class="tsd-legend">
765
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
766
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
767
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
768
- </ul>
769
- <ul class="tsd-legend">
770
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
771
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
772
- </ul>
773
- </div>
774
- </div>
775
- </footer>
776
- <div class="container tsd-generator">
777
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
778
- </div>
779
- <div class="overlay"></div>
780
- <script src="../assets/js/main.js"></script>
781
- <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
782
- </body>
783
- </html>