Skip to content

Commit 10be7fb

Browse files
author
Marco Crespi
committed
chore: Update docs
1 parent 09e7502 commit 10be7fb

20 files changed

+162
-162
lines changed

‎docs/classes/adapter.html‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ <h3>constructor</h3>
151151
<li class="tsd-description">
152152
<aside class="tsd-sources">
153153
<ul>
154-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L49">src/models/Adapter.ts:49</a></li>
154+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L49">src/models/Adapter.ts:49</a></li>
155155
</ul>
156156
</aside>
157157
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -182,7 +182,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3>
182182
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
183183
<aside class="tsd-sources">
184184
<ul>
185-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L25">src/models/Adapter.ts:25</a></li>
185+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L25">src/models/Adapter.ts:25</a></li>
186186
</ul>
187187
</aside>
188188
<div class="tsd-comment tsd-typography">
@@ -197,7 +197,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> modblue</h3>
197197
<div class="tsd-signature tsd-kind-icon">modblue<span class="tsd-signature-symbol">:</span> <a href="modblue.html" class="tsd-signature-type" data-tsd-kind="Class">MODblue</a></div>
198198
<aside class="tsd-sources">
199199
<ul>
200-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L20">src/models/Adapter.ts:20</a></li>
200+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L20">src/models/Adapter.ts:20</a></li>
201201
</ul>
202202
</aside>
203203
<div class="tsd-comment tsd-typography">
@@ -229,7 +229,7 @@ <h3>address</h3>
229229
<li class="tsd-description">
230230
<aside class="tsd-sources">
231231
<ul>
232-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L47">src/models/Adapter.ts:47</a></li>
232+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L47">src/models/Adapter.ts:47</a></li>
233233
</ul>
234234
</aside>
235235
<div class="tsd-comment tsd-typography">
@@ -251,7 +251,7 @@ <h3>address<wbr>Type</h3>
251251
<li class="tsd-description">
252252
<aside class="tsd-sources">
253253
<ul>
254-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L39">src/models/Adapter.ts:39</a></li>
254+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L39">src/models/Adapter.ts:39</a></li>
255255
</ul>
256256
</aside>
257257
<div class="tsd-comment tsd-typography">
@@ -273,7 +273,7 @@ <h3>name</h3>
273273
<li class="tsd-description">
274274
<aside class="tsd-sources">
275275
<ul>
276-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L31">src/models/Adapter.ts:31</a></li>
276+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L31">src/models/Adapter.ts:31</a></li>
277277
</ul>
278278
</aside>
279279
<div class="tsd-comment tsd-typography">
@@ -298,7 +298,7 @@ <h3>[custom]</h3>
298298
<li class="tsd-description">
299299
<aside class="tsd-sources">
300300
<ul>
301-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L161">src/models/Adapter.ts:161</a></li>
301+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L161">src/models/Adapter.ts:161</a></li>
302302
</ul>
303303
</aside>
304304
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -428,7 +428,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Scanned<wbr>P
428428
<li class="tsd-description">
429429
<aside class="tsd-sources">
430430
<ul>
431-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L125">src/models/Adapter.ts:125</a></li>
431+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L125">src/models/Adapter.ts:125</a></li>
432432
</ul>
433433
</aside>
434434
<div class="tsd-comment tsd-typography">
@@ -450,7 +450,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> is<wbr>Advertising</h
450450
<li class="tsd-description">
451451
<aside class="tsd-sources">
452452
<ul>
453-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L130">src/models/Adapter.ts:130</a></li>
453+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L130">src/models/Adapter.ts:130</a></li>
454454
</ul>
455455
</aside>
456456
<div class="tsd-comment tsd-typography">
@@ -472,7 +472,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> is<wbr>Scanning</h3>
472472
<li class="tsd-description">
473473
<aside class="tsd-sources">
474474
<ul>
475-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L108">src/models/Adapter.ts:108</a></li>
475+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L108">src/models/Adapter.ts:108</a></li>
476476
</ul>
477477
</aside>
478478
<div class="tsd-comment tsd-typography">
@@ -790,7 +790,7 @@ <h3>scan<wbr>For</h3>
790790
<li class="tsd-description">
791791
<aside class="tsd-sources">
792792
<ul>
793-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L67">src/models/Adapter.ts:67</a></li>
793+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L67">src/models/Adapter.ts:67</a></li>
794794
</ul>
795795
</aside>
796796
<div class="tsd-comment tsd-typography">
@@ -875,7 +875,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> setup<wbr>Gatt</h3>
875875
<li class="tsd-description">
876876
<aside class="tsd-sources">
877877
<ul>
878-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L147">src/models/Adapter.ts:147</a></li>
878+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L147">src/models/Adapter.ts:147</a></li>
879879
</ul>
880880
</aside>
881881
<div class="tsd-comment tsd-typography">
@@ -906,7 +906,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> start<wbr>Advertising
906906
<li class="tsd-description">
907907
<aside class="tsd-sources">
908908
<ul>
909-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L137">src/models/Adapter.ts:137</a></li>
909+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L137">src/models/Adapter.ts:137</a></li>
910910
</ul>
911911
</aside>
912912
<div class="tsd-comment tsd-typography">
@@ -943,7 +943,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> start<wbr>Scanning</h
943943
<li class="tsd-description">
944944
<aside class="tsd-sources">
945945
<ul>
946-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L116">src/models/Adapter.ts:116</a></li>
946+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L116">src/models/Adapter.ts:116</a></li>
947947
</ul>
948948
</aside>
949949
<div class="tsd-comment tsd-typography">
@@ -981,7 +981,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> stop<wbr>Advertising<
981981
<li class="tsd-description">
982982
<aside class="tsd-sources">
983983
<ul>
984-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L141">src/models/Adapter.ts:141</a></li>
984+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L141">src/models/Adapter.ts:141</a></li>
985985
</ul>
986986
</aside>
987987
<div class="tsd-comment tsd-typography">
@@ -1003,7 +1003,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> stop<wbr>Scanning</h3
10031003
<li class="tsd-description">
10041004
<aside class="tsd-sources">
10051005
<ul>
1006-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L120">src/models/Adapter.ts:120</a></li>
1006+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L120">src/models/Adapter.ts:120</a></li>
10071007
</ul>
10081008
</aside>
10091009
<div class="tsd-comment tsd-typography">
@@ -1025,7 +1025,7 @@ <h3>toJSON</h3>
10251025
<li class="tsd-description">
10261026
<aside class="tsd-sources">
10271027
<ul>
1028-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L153">src/models/Adapter.ts:153</a></li>
1028+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L153">src/models/Adapter.ts:153</a></li>
10291029
</ul>
10301030
</aside>
10311031
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
@@ -1053,7 +1053,7 @@ <h3>to<wbr>String</h3>
10531053
<li class="tsd-description">
10541054
<aside class="tsd-sources">
10551055
<ul>
1056-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/Adapter.ts#L149">src/models/Adapter.ts:149</a></li>
1056+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/Adapter.ts#L149">src/models/Adapter.ts:149</a></li>
10571057
</ul>
10581058
</aside>
10591059
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>

‎docs/classes/gatt.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ <h3>[custom]</h3>
138138
<li class="tsd-description">
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Gatt.ts#L15">src/models/gatt/Gatt.ts:15</a></li>
141+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Gatt.ts#L15">src/models/gatt/Gatt.ts:15</a></li>
142142
</ul>
143143
</aside>
144144
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -164,7 +164,7 @@ <h3>toJSON</h3>
164164
<li class="tsd-description">
165165
<aside class="tsd-sources">
166166
<ul>
167-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Gatt.ts#L11">src/models/gatt/Gatt.ts:11</a></li>
167+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Gatt.ts#L11">src/models/gatt/Gatt.ts:11</a></li>
168168
</ul>
169169
</aside>
170170
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4>
@@ -183,7 +183,7 @@ <h3>to<wbr>String</h3>
183183
<li class="tsd-description">
184184
<aside class="tsd-sources">
185185
<ul>
186-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Gatt.ts#L7">src/models/gatt/Gatt.ts:7</a></li>
186+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Gatt.ts#L7">src/models/gatt/Gatt.ts:7</a></li>
187187
</ul>
188188
</aside>
189189
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>

‎docs/classes/gattcharacteristic.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ <h3>constructor</h3>
153153
<li class="tsd-description">
154154
<aside class="tsd-sources">
155155
<ul>
156-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L54">src/models/gatt/Characteristic.ts:54</a></li>
156+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L54">src/models/gatt/Characteristic.ts:54</a></li>
157157
</ul>
158158
</aside>
159159
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -184,7 +184,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> properties</h3>
184184
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <a href="../modules.html#gattcharacteristicproperty" class="tsd-signature-type" data-tsd-kind="Type alias">GattCharacteristicProperty</a><span class="tsd-signature-symbol">[]</span></div>
185185
<aside class="tsd-sources">
186186
<ul>
187-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L42">src/models/gatt/Characteristic.ts:42</a></li>
187+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L42">src/models/gatt/Characteristic.ts:42</a></li>
188188
</ul>
189189
</aside>
190190
<div class="tsd-comment tsd-typography">
@@ -199,7 +199,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> property<wbr>Flag</h3
199199
<div class="tsd-signature tsd-kind-icon">property<wbr>Flag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
200200
<aside class="tsd-sources">
201201
<ul>
202-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L46">src/models/gatt/Characteristic.ts:46</a></li>
202+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L46">src/models/gatt/Characteristic.ts:46</a></li>
203203
</ul>
204204
</aside>
205205
<div class="tsd-comment tsd-typography">
@@ -214,7 +214,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> secure</h3>
214214
<div class="tsd-signature tsd-kind-icon">secure<span class="tsd-signature-symbol">:</span> <a href="../modules.html#gattcharacteristicproperty" class="tsd-signature-type" data-tsd-kind="Type alias">GattCharacteristicProperty</a><span class="tsd-signature-symbol">[]</span></div>
215215
<aside class="tsd-sources">
216216
<ul>
217-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L50">src/models/gatt/Characteristic.ts:50</a></li>
217+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L50">src/models/gatt/Characteristic.ts:50</a></li>
218218
</ul>
219219
</aside>
220220
<div class="tsd-comment tsd-typography">
@@ -229,7 +229,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> secure<wbr>Flag</h3>
229229
<div class="tsd-signature tsd-kind-icon">secure<wbr>Flag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
230230
<aside class="tsd-sources">
231231
<ul>
232-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L54">src/models/gatt/Characteristic.ts:54</a></li>
232+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L54">src/models/gatt/Characteristic.ts:54</a></li>
233233
</ul>
234234
</aside>
235235
<div class="tsd-comment tsd-typography">
@@ -244,7 +244,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> service</h3>
244244
<div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <a href="gattservice.html" class="tsd-signature-type" data-tsd-kind="Class">GattService</a></div>
245245
<aside class="tsd-sources">
246246
<ul>
247-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L32">src/models/gatt/Characteristic.ts:32</a></li>
247+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L32">src/models/gatt/Characteristic.ts:32</a></li>
248248
</ul>
249249
</aside>
250250
<div class="tsd-comment tsd-typography">
@@ -259,7 +259,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> uuid</h3>
259259
<div class="tsd-signature tsd-kind-icon">uuid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
260260
<aside class="tsd-sources">
261261
<ul>
262-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L37">src/models/gatt/Characteristic.ts:37</a></li>
262+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L37">src/models/gatt/Characteristic.ts:37</a></li>
263263
</ul>
264264
</aside>
265265
<div class="tsd-comment tsd-typography">
@@ -291,7 +291,7 @@ <h3>[custom]</h3>
291291
<li class="tsd-description">
292292
<aside class="tsd-sources">
293293
<ul>
294-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L186">src/models/gatt/Characteristic.ts:186</a></li>
294+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L186">src/models/gatt/Characteristic.ts:186</a></li>
295295
</ul>
296296
</aside>
297297
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -740,7 +740,7 @@ <h3>toJSON</h3>
740740
<li class="tsd-description">
741741
<aside class="tsd-sources">
742742
<ul>
743-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L177">src/models/gatt/Characteristic.ts:177</a></li>
743+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L177">src/models/gatt/Characteristic.ts:177</a></li>
744744
</ul>
745745
</aside>
746746
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>properties<span class="tsd-signature-symbol">: </span><a href="../modules.html#gattcharacteristicproperty" class="tsd-signature-type" data-tsd-kind="Type alias">GattCharacteristicProperty</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>secure<span class="tsd-signature-symbol">: </span><a href="../modules.html#gattcharacteristicproperty" class="tsd-signature-type" data-tsd-kind="Type alias">GattCharacteristicProperty</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>service<span class="tsd-signature-symbol">: </span><a href="gattservice.html" class="tsd-signature-type" data-tsd-kind="Class">GattService</a><span class="tsd-signature-symbol">; </span>uuid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
@@ -771,7 +771,7 @@ <h3>to<wbr>String</h3>
771771
<li class="tsd-description">
772772
<aside class="tsd-sources">
773773
<ul>
774-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/7422855/src/models/gatt/Characteristic.ts#L173">src/models/gatt/Characteristic.ts:173</a></li>
774+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/9b61eb3/src/models/gatt/Characteristic.ts#L173">src/models/gatt/Characteristic.ts:173</a></li>
775775
</ul>
776776
</aside>
777777
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>

0 commit comments

Comments
 (0)