@signalk/server-api 1.39.0 → 2.0.0-beta.2
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.
- package/dist/autopilot.d.ts +28 -0
- package/dist/autopilot.js +2 -0
- package/dist/index.d.ts +70 -1
- package/dist/index.js +21 -1
- package/dist/propertyvalues.test.js +5 -7
- package/dist/resourcetypes.d.ts +80 -0
- package/dist/resourcetypes.js +2 -0
- package/package.json +4 -2
- package/tsconfig.json +2 -2
- package/tsconfig.tsbuildinfo +3475 -0
- package/docs/assets/css/main.css +0 -2638
- package/docs/assets/images/icons.png +0 -0
- package/docs/assets/images/icons@2x.png +0 -0
- package/docs/assets/images/widgets.png +0 -0
- package/docs/assets/images/widgets@2x.png +0 -0
- package/docs/assets/js/main.js +0 -248
- package/docs/assets/js/search.js +0 -1
- package/docs/classes/propertyvalues.propertyvalues-1.html +0 -361
- package/docs/index.html +0 -348
- package/docs/interfaces/index.plugin.html +0 -400
- package/docs/interfaces/index.pluginserverapp.html +0 -257
- package/docs/interfaces/index.propertyvaluesemitter.html +0 -247
- package/docs/interfaces/propertyvalues.propertyvalue.html +0 -213
- package/docs/interfaces/types.bus.html +0 -339
- package/docs/modules/index.html +0 -174
- package/docs/modules/propertyvalues.html +0 -183
- package/docs/modules/propertyvalues_test.html +0 -106
- package/docs/modules/types.html +0 -131
- package/docs/modules/types_baconjs.html +0 -106
- package/docs/modules.html +0 -124
|
@@ -1,400 +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>Plugin | @signalk/server-api</title>
|
|
7
|
-
<meta name="description" content="Documentation for @signalk/server-api">
|
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
-
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
-
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
-
</head>
|
|
12
|
-
<body>
|
|
13
|
-
<header>
|
|
14
|
-
<div class="tsd-page-toolbar">
|
|
15
|
-
<div class="container">
|
|
16
|
-
<div class="table-wrap">
|
|
17
|
-
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
-
<div class="field">
|
|
19
|
-
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
-
<input id="tsd-search-field" type="text" />
|
|
21
|
-
</div>
|
|
22
|
-
<ul class="results">
|
|
23
|
-
<li class="state loading">Preparing search index...</li>
|
|
24
|
-
<li class="state failure">The search index is not available</li>
|
|
25
|
-
</ul>
|
|
26
|
-
<a href="../index.html" class="title">@signalk/server-api</a>
|
|
27
|
-
</div>
|
|
28
|
-
<div class="table-cell" id="tsd-widgets">
|
|
29
|
-
<div id="tsd-filter">
|
|
30
|
-
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
-
<div class="tsd-filter-group">
|
|
32
|
-
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
-
<span class="tsd-select-label">All</span>
|
|
34
|
-
<ul class="tsd-select-list">
|
|
35
|
-
<li data-value="public">Public</li>
|
|
36
|
-
<li data-value="protected">Public/Protected</li>
|
|
37
|
-
<li data-value="private" class="selected">All</li>
|
|
38
|
-
</ul>
|
|
39
|
-
</div>
|
|
40
|
-
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
-
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
-
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
-
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
-
</div>
|
|
45
|
-
</div>
|
|
46
|
-
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
-
</div>
|
|
48
|
-
</div>
|
|
49
|
-
</div>
|
|
50
|
-
</div>
|
|
51
|
-
<div class="tsd-page-title">
|
|
52
|
-
<div class="container">
|
|
53
|
-
<ul class="tsd-breadcrumb">
|
|
54
|
-
<li>
|
|
55
|
-
<a href="../modules.html">@signalk/server-api</a>
|
|
56
|
-
</li>
|
|
57
|
-
<li>
|
|
58
|
-
<a href="../modules/index.html">index</a>
|
|
59
|
-
</li>
|
|
60
|
-
<li>
|
|
61
|
-
<a href="index.plugin.html">Plugin</a>
|
|
62
|
-
</li>
|
|
63
|
-
</ul>
|
|
64
|
-
<h1>Interface Plugin</h1>
|
|
65
|
-
</div>
|
|
66
|
-
</div>
|
|
67
|
-
</header>
|
|
68
|
-
<div class="container container-main">
|
|
69
|
-
<div class="row">
|
|
70
|
-
<div class="col-8 col-content">
|
|
71
|
-
<section class="tsd-panel tsd-comment">
|
|
72
|
-
<div class="tsd-comment tsd-typography">
|
|
73
|
-
<div class="lead">
|
|
74
|
-
<p>This is the API that a <a href="https://github.com/SignalK/signalk-server/blob/master/SERVERPLUGINS.md">server plugin</a> must implement.</p>
|
|
75
|
-
</div>
|
|
76
|
-
<p>Typing is INCOMPLETE.</p>
|
|
77
|
-
</div>
|
|
78
|
-
</section>
|
|
79
|
-
<section class="tsd-panel tsd-hierarchy">
|
|
80
|
-
<h3>Hierarchy</h3>
|
|
81
|
-
<ul class="tsd-hierarchy">
|
|
82
|
-
<li>
|
|
83
|
-
<span class="target">Plugin</span>
|
|
84
|
-
</li>
|
|
85
|
-
</ul>
|
|
86
|
-
</section>
|
|
87
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
88
|
-
<h2>Index</h2>
|
|
89
|
-
<section class="tsd-panel tsd-index-panel">
|
|
90
|
-
<div class="tsd-index-content">
|
|
91
|
-
<section class="tsd-index-section ">
|
|
92
|
-
<h3>Properties</h3>
|
|
93
|
-
<ul class="tsd-index-list">
|
|
94
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#enabledbydefault" class="tsd-kind-icon">enabled<wbr>ByDefault</a></li>
|
|
95
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#id" class="tsd-kind-icon">id</a></li>
|
|
96
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#name" class="tsd-kind-icon">name</a></li>
|
|
97
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#registerwithrouter" class="tsd-kind-icon">register<wbr>With<wbr>Router</a></li>
|
|
98
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#schema" class="tsd-kind-icon">schema</a></li>
|
|
99
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#signalkapiroutes" class="tsd-kind-icon">signalKApi<wbr>Routes</a></li>
|
|
100
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#start" class="tsd-kind-icon">start</a></li>
|
|
101
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#stop" class="tsd-kind-icon">stop</a></li>
|
|
102
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.plugin.html#uischema" class="tsd-kind-icon">ui<wbr>Schema</a></li>
|
|
103
|
-
</ul>
|
|
104
|
-
</section>
|
|
105
|
-
</div>
|
|
106
|
-
</section>
|
|
107
|
-
</section>
|
|
108
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
109
|
-
<h2>Properties</h2>
|
|
110
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
111
|
-
<a name="enabledbydefault" class="tsd-anchor"></a>
|
|
112
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled<wbr>ByDefault</h3>
|
|
113
|
-
<div class="tsd-signature tsd-kind-icon">enabled<wbr>ByDefault<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
|
|
114
|
-
<aside class="tsd-sources">
|
|
115
|
-
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L56">index.ts:56</a></li>
|
|
117
|
-
</ul>
|
|
118
|
-
</aside>
|
|
119
|
-
</section>
|
|
120
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
121
|
-
<a name="id" class="tsd-anchor"></a>
|
|
122
|
-
<h3>id</h3>
|
|
123
|
-
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
124
|
-
<aside class="tsd-sources">
|
|
125
|
-
<ul>
|
|
126
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L31">index.ts:31</a></li>
|
|
127
|
-
</ul>
|
|
128
|
-
</aside>
|
|
129
|
-
<div class="tsd-comment tsd-typography">
|
|
130
|
-
<div class="lead">
|
|
131
|
-
<p>Used to identify the plugin in the server, for example
|
|
132
|
-
when storing the plugin's configuration and in http endpoints.</p>
|
|
133
|
-
</div>
|
|
134
|
-
</div>
|
|
135
|
-
</section>
|
|
136
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
137
|
-
<a name="name" class="tsd-anchor"></a>
|
|
138
|
-
<h3>name</h3>
|
|
139
|
-
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
140
|
-
<aside class="tsd-sources">
|
|
141
|
-
<ul>
|
|
142
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L37">index.ts:37</a></li>
|
|
143
|
-
</ul>
|
|
144
|
-
</aside>
|
|
145
|
-
<div class="tsd-comment tsd-typography">
|
|
146
|
-
<div class="lead">
|
|
147
|
-
<p>Human oriented name for the plugin. This is used in the
|
|
148
|
-
server's plugin configuration user interface.</p>
|
|
149
|
-
</div>
|
|
150
|
-
</div>
|
|
151
|
-
</section>
|
|
152
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
153
|
-
<a name="registerwithrouter" class="tsd-anchor"></a>
|
|
154
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> register<wbr>With<wbr>Router</h3>
|
|
155
|
-
<div class="tsd-signature tsd-kind-icon">register<wbr>With<wbr>Router<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">(</span>router<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IRouter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
|
|
156
|
-
<aside class="tsd-sources">
|
|
157
|
-
<ul>
|
|
158
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L54">index.ts:54</a></li>
|
|
159
|
-
</ul>
|
|
160
|
-
</aside>
|
|
161
|
-
</section>
|
|
162
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
163
|
-
<a name="schema" class="tsd-anchor"></a>
|
|
164
|
-
<h3>schema</h3>
|
|
165
|
-
<div class="tsd-signature tsd-kind-icon">schema<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">object</span></div>
|
|
166
|
-
<aside class="tsd-sources">
|
|
167
|
-
<ul>
|
|
168
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L52">index.ts:52</a></li>
|
|
169
|
-
</ul>
|
|
170
|
-
</aside>
|
|
171
|
-
<div class="tsd-type-declaration">
|
|
172
|
-
<h4>Type declaration</h4>
|
|
173
|
-
<ul class="tsd-parameters">
|
|
174
|
-
<li class="tsd-parameter-signature">
|
|
175
|
-
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
|
|
176
|
-
<li class="tsd-signature tsd-kind-icon"><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>
|
|
177
|
-
</ul>
|
|
178
|
-
<ul class="tsd-descriptions">
|
|
179
|
-
<li class="tsd-description">
|
|
180
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
|
|
181
|
-
</li>
|
|
182
|
-
</ul>
|
|
183
|
-
</li>
|
|
184
|
-
</ul>
|
|
185
|
-
</div>
|
|
186
|
-
</section>
|
|
187
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
188
|
-
<a name="signalkapiroutes" class="tsd-anchor"></a>
|
|
189
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> signalKApi<wbr>Routes</h3>
|
|
190
|
-
<div class="tsd-signature tsd-kind-icon">signalKApi<wbr>Routes<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">(</span>router<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IRouter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">IRouter</span><span class="tsd-signature-symbol">)</span></div>
|
|
191
|
-
<aside class="tsd-sources">
|
|
192
|
-
<ul>
|
|
193
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L55">index.ts:55</a></li>
|
|
194
|
-
</ul>
|
|
195
|
-
</aside>
|
|
196
|
-
</section>
|
|
197
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
198
|
-
<a name="start" class="tsd-anchor"></a>
|
|
199
|
-
<h3>start</h3>
|
|
200
|
-
<div class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, restart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>newConfiguration<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></div>
|
|
201
|
-
<aside class="tsd-sources">
|
|
202
|
-
<ul>
|
|
203
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L46">index.ts:46</a></li>
|
|
204
|
-
</ul>
|
|
205
|
-
</aside>
|
|
206
|
-
<div class="tsd-comment tsd-typography">
|
|
207
|
-
<div class="lead">
|
|
208
|
-
<p>Called to start the plugin with latest saved configuration. Called</p>
|
|
209
|
-
<ul>
|
|
210
|
-
<li>for enabled (by configuration or by default) plugins during server startup</li>
|
|
211
|
-
<li>after stop() when the configuration of an enabled plugin has been updated
|
|
212
|
-
in the admin UI</li>
|
|
213
|
-
<li>when a plugin is Enabled in the admin UI</li>
|
|
214
|
-
</ul>
|
|
215
|
-
</div>
|
|
216
|
-
</div>
|
|
217
|
-
<div class="tsd-type-declaration">
|
|
218
|
-
<h4>Type declaration</h4>
|
|
219
|
-
<ul class="tsd-parameters">
|
|
220
|
-
<li class="tsd-parameter-signature">
|
|
221
|
-
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
|
|
222
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, restart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>newConfiguration<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
223
|
-
</ul>
|
|
224
|
-
<ul class="tsd-descriptions">
|
|
225
|
-
<li class="tsd-description">
|
|
226
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
227
|
-
<ul class="tsd-parameters">
|
|
228
|
-
<li>
|
|
229
|
-
<h5>config: <span class="tsd-signature-type">object</span></h5>
|
|
230
|
-
</li>
|
|
231
|
-
<li>
|
|
232
|
-
<h5>restart: <span class="tsd-signature-symbol">(</span>newConfiguration<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></h5>
|
|
233
|
-
<ul class="tsd-parameters">
|
|
234
|
-
<li class="tsd-parameter-signature">
|
|
235
|
-
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
236
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>newConfiguration<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>
|
|
237
|
-
</ul>
|
|
238
|
-
<ul class="tsd-descriptions">
|
|
239
|
-
<li class="tsd-description">
|
|
240
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
241
|
-
<ul class="tsd-parameters">
|
|
242
|
-
<li>
|
|
243
|
-
<h5>newConfiguration: <span class="tsd-signature-type">object</span></h5>
|
|
244
|
-
</li>
|
|
245
|
-
</ul>
|
|
246
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
247
|
-
</li>
|
|
248
|
-
</ul>
|
|
249
|
-
</li>
|
|
250
|
-
</ul>
|
|
251
|
-
</li>
|
|
252
|
-
</ul>
|
|
253
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
254
|
-
</li>
|
|
255
|
-
</ul>
|
|
256
|
-
</li>
|
|
257
|
-
</ul>
|
|
258
|
-
</div>
|
|
259
|
-
</section>
|
|
260
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
261
|
-
<a name="stop" class="tsd-anchor"></a>
|
|
262
|
-
<h3>stop</h3>
|
|
263
|
-
<div class="tsd-signature tsd-kind-icon">stop<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">void</span></div>
|
|
264
|
-
<aside class="tsd-sources">
|
|
265
|
-
<ul>
|
|
266
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L51">index.ts:51</a></li>
|
|
267
|
-
</ul>
|
|
268
|
-
</aside>
|
|
269
|
-
<div class="tsd-comment tsd-typography">
|
|
270
|
-
<div class="lead">
|
|
271
|
-
<p>Called to stop the plugin. Called when the user disables the plugin in the admin UI.</p>
|
|
272
|
-
</div>
|
|
273
|
-
</div>
|
|
274
|
-
<div class="tsd-type-declaration">
|
|
275
|
-
<h4>Type declaration</h4>
|
|
276
|
-
<ul class="tsd-parameters">
|
|
277
|
-
<li class="tsd-parameter-signature">
|
|
278
|
-
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
|
|
279
|
-
<li class="tsd-signature tsd-kind-icon"><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></li>
|
|
280
|
-
</ul>
|
|
281
|
-
<ul class="tsd-descriptions">
|
|
282
|
-
<li class="tsd-description">
|
|
283
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
284
|
-
</li>
|
|
285
|
-
</ul>
|
|
286
|
-
</li>
|
|
287
|
-
</ul>
|
|
288
|
-
</div>
|
|
289
|
-
</section>
|
|
290
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
291
|
-
<a name="uischema" class="tsd-anchor"></a>
|
|
292
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ui<wbr>Schema</h3>
|
|
293
|
-
<div class="tsd-signature tsd-kind-icon">ui<wbr>Schema<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">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div>
|
|
294
|
-
<aside class="tsd-sources">
|
|
295
|
-
<ul>
|
|
296
|
-
<li>Defined in <a href="https://github.com/SignalK/signalk-server/blob/6d3bb94/packages/server-api/src/index.ts#L53">index.ts:53</a></li>
|
|
297
|
-
</ul>
|
|
298
|
-
</aside>
|
|
299
|
-
</section>
|
|
300
|
-
</section>
|
|
301
|
-
</div>
|
|
302
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
303
|
-
<nav class="tsd-navigation primary">
|
|
304
|
-
<ul>
|
|
305
|
-
<li class=" ">
|
|
306
|
-
<a href="../modules.html">Exports</a>
|
|
307
|
-
</li>
|
|
308
|
-
<li class="current tsd-kind-module">
|
|
309
|
-
<a href="../modules/index.html">index</a>
|
|
310
|
-
</li>
|
|
311
|
-
<li class=" tsd-kind-module">
|
|
312
|
-
<a href="../modules/propertyvalues.html">propertyvalues</a>
|
|
313
|
-
</li>
|
|
314
|
-
<li class=" tsd-kind-module">
|
|
315
|
-
<a href="../modules/types.html">types</a>
|
|
316
|
-
</li>
|
|
317
|
-
</ul>
|
|
318
|
-
</nav>
|
|
319
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
320
|
-
<ul class="before-current">
|
|
321
|
-
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
322
|
-
<a href="../modules/index.html#propertyvalue" class="tsd-kind-icon">Property<wbr>Value</a>
|
|
323
|
-
</li>
|
|
324
|
-
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
325
|
-
<a href="../modules/index.html#propertyvalues" class="tsd-kind-icon">Property<wbr>Values</a>
|
|
326
|
-
</li>
|
|
327
|
-
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
328
|
-
<a href="../modules/index.html#propertyvaluescallback" class="tsd-kind-icon">Property<wbr>Values<wbr>Callback</a>
|
|
329
|
-
</li>
|
|
330
|
-
</ul>
|
|
331
|
-
<ul class="current">
|
|
332
|
-
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
333
|
-
<a href="index.plugin.html" class="tsd-kind-icon">Plugin</a>
|
|
334
|
-
<ul>
|
|
335
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
336
|
-
<a href="index.plugin.html#enabledbydefault" class="tsd-kind-icon">enabled<wbr>ByDefault</a>
|
|
337
|
-
</li>
|
|
338
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
339
|
-
<a href="index.plugin.html#id" class="tsd-kind-icon">id</a>
|
|
340
|
-
</li>
|
|
341
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
342
|
-
<a href="index.plugin.html#name" class="tsd-kind-icon">name</a>
|
|
343
|
-
</li>
|
|
344
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
345
|
-
<a href="index.plugin.html#registerwithrouter" class="tsd-kind-icon">register<wbr>With<wbr>Router</a>
|
|
346
|
-
</li>
|
|
347
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
348
|
-
<a href="index.plugin.html#schema" class="tsd-kind-icon">schema</a>
|
|
349
|
-
</li>
|
|
350
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
351
|
-
<a href="index.plugin.html#signalkapiroutes" class="tsd-kind-icon">signalKApi<wbr>Routes</a>
|
|
352
|
-
</li>
|
|
353
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
354
|
-
<a href="index.plugin.html#start" class="tsd-kind-icon">start</a>
|
|
355
|
-
</li>
|
|
356
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
357
|
-
<a href="index.plugin.html#stop" class="tsd-kind-icon">stop</a>
|
|
358
|
-
</li>
|
|
359
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
360
|
-
<a href="index.plugin.html#uischema" class="tsd-kind-icon">ui<wbr>Schema</a>
|
|
361
|
-
</li>
|
|
362
|
-
</ul>
|
|
363
|
-
</li>
|
|
364
|
-
</ul>
|
|
365
|
-
<ul class="after-current">
|
|
366
|
-
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
367
|
-
<a href="index.pluginserverapp.html" class="tsd-kind-icon">Plugin<wbr>Server<wbr>App</a>
|
|
368
|
-
</li>
|
|
369
|
-
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
370
|
-
<a href="index.propertyvaluesemitter.html" class="tsd-kind-icon">Property<wbr>Values<wbr>Emitter</a>
|
|
371
|
-
</li>
|
|
372
|
-
</ul>
|
|
373
|
-
</nav>
|
|
374
|
-
</div>
|
|
375
|
-
</div>
|
|
376
|
-
</div>
|
|
377
|
-
<footer class="with-border-bottom">
|
|
378
|
-
<div class="container">
|
|
379
|
-
<h2>Legend</h2>
|
|
380
|
-
<div class="tsd-legend-group">
|
|
381
|
-
<ul class="tsd-legend">
|
|
382
|
-
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
383
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
384
|
-
</ul>
|
|
385
|
-
<ul class="tsd-legend">
|
|
386
|
-
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
387
|
-
</ul>
|
|
388
|
-
<ul class="tsd-legend">
|
|
389
|
-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
390
|
-
</ul>
|
|
391
|
-
</div>
|
|
392
|
-
</div>
|
|
393
|
-
</footer>
|
|
394
|
-
<div class="container tsd-generator">
|
|
395
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
396
|
-
</div>
|
|
397
|
-
<div class="overlay"></div>
|
|
398
|
-
<script src="../assets/js/main.js"></script>
|
|
399
|
-
</body>
|
|
400
|
-
</html>
|