Skip to content

Commit a5b9c5b

Browse files
farfromrefugactions-user
authored andcommitted
chore: update doc
1 parent 8c036fd commit a5b9c5b

21 files changed

+283
-136
lines changed

docs/classes/Bluetooth.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,8 @@ <h3 class="tsd-anchor-link"><span>send<wbr/>Event</span><a href="#sendEvent" ari
512512
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
513513
<li class="tsd-signature tsd-anchor-link" id="sendEvent.sendEvent-1">send<wbr/>Event<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, msg<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendEvent.sendEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
514514
<li class="tsd-description">
515+
<div class="tsd-comment tsd-typography"><p>Notify events by name and optionally pass data</p>
516+
</div>
515517
<div class="tsd-parameters">
516518
<h4 class="tsd-parameters-title">Parameters</h4>
517519
<ul class="tsd-parameter-list">
@@ -524,7 +526,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> msg: <span class="tsd-
524526
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
525527
<p>Inherited from BluetoothCommon.sendEvent</p>
526528
<ul>
527-
<li>Defined in packages/ble/index.common.d.ts:55</li></ul></aside></li></ul></section>
529+
<li>Defined in packages/ble/index.common.d.ts:58</li></ul></aside></li></ul></section>
528530
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="startNotifying" class="tsd-anchor"></a>
529531
<h3 class="tsd-anchor-link"><span>start<wbr/>Notifying</span><a href="#startNotifying" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
530532
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">

docs/enums/CallbackType.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<li><a href="CallbackType.html">CallbackType</a></li></ul>
1717
<h1>Enumeration CallbackType</h1></div><aside class="tsd-sources">
1818
<ul>
19-
<li>Defined in packages/ble/index.common.d.ts:78</li></ul></aside>
19+
<li>Defined in packages/ble/index.common.d.ts:81</li></ul></aside>
2020
<section class="tsd-panel-group tsd-index-group">
2121
<section class="tsd-panel tsd-index-panel">
2222
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,17 +34,17 @@ <h2>Enumeration Members</h2>
3434
<h3 class="tsd-anchor-link"><span>ALL_<wbr/>MATCHES</span><a href="#ALL_MATCHES" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
3535
<div class="tsd-signature">ALL_<wbr/>MATCHES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
3636
<ul>
37-
<li>Defined in packages/ble/index.common.d.ts:79</li></ul></aside></section>
37+
<li>Defined in packages/ble/index.common.d.ts:82</li></ul></aside></section>
3838
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FIRST_MATCH" class="tsd-anchor"></a>
3939
<h3 class="tsd-anchor-link"><span>FIRST_<wbr/>MATCH</span><a href="#FIRST_MATCH" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4040
<div class="tsd-signature">FIRST_<wbr/>MATCH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
4141
<ul>
42-
<li>Defined in packages/ble/index.common.d.ts:80</li></ul></aside></section>
42+
<li>Defined in packages/ble/index.common.d.ts:83</li></ul></aside></section>
4343
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="MATCH_LOST" class="tsd-anchor"></a>
4444
<h3 class="tsd-anchor-link"><span>MATCH_<wbr/>LOST</span><a href="#MATCH_LOST" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4545
<div class="tsd-signature">MATCH_<wbr/>LOST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
4646
<ul>
47-
<li>Defined in packages/ble/index.common.d.ts:81</li></ul></aside></section></section></div>
47+
<li>Defined in packages/ble/index.common.d.ts:84</li></ul></aside></section></section></div>
4848
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
4949
<div class="tsd-navigation settings">
5050
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/enums/MatchMode.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<li><a href="MatchMode.html">MatchMode</a></li></ul>
1717
<h1>Enumeration MatchMode</h1></div><aside class="tsd-sources">
1818
<ul>
19-
<li>Defined in packages/ble/index.common.d.ts:69</li></ul></aside>
19+
<li>Defined in packages/ble/index.common.d.ts:72</li></ul></aside>
2020
<section class="tsd-panel-group tsd-index-group">
2121
<section class="tsd-panel tsd-index-panel">
2222
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,12 +33,12 @@ <h2>Enumeration Members</h2>
3333
<h3 class="tsd-anchor-link"><span>AGGRESSIVE</span><a href="#AGGRESSIVE" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
3434
<div class="tsd-signature">AGGRESSIVE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
3535
<ul>
36-
<li>Defined in packages/ble/index.common.d.ts:70</li></ul></aside></section>
36+
<li>Defined in packages/ble/index.common.d.ts:73</li></ul></aside></section>
3737
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="STICKY" class="tsd-anchor"></a>
3838
<h3 class="tsd-anchor-link"><span>STICKY</span><a href="#STICKY" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3939
<div class="tsd-signature">STICKY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
4040
<ul>
41-
<li>Defined in packages/ble/index.common.d.ts:71</li></ul></aside></section></section></div>
41+
<li>Defined in packages/ble/index.common.d.ts:74</li></ul></aside></section></section></div>
4242
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
4343
<div class="tsd-navigation settings">
4444
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/enums/MatchNum.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<li><a href="MatchNum.html">MatchNum</a></li></ul>
1717
<h1>Enumeration MatchNum</h1></div><aside class="tsd-sources">
1818
<ul>
19-
<li>Defined in packages/ble/index.common.d.ts:73</li></ul></aside>
19+
<li>Defined in packages/ble/index.common.d.ts:76</li></ul></aside>
2020
<section class="tsd-panel-group tsd-index-group">
2121
<section class="tsd-panel tsd-index-panel">
2222
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,17 +34,17 @@ <h2>Enumeration Members</h2>
3434
<h3 class="tsd-anchor-link"><span>FEW_<wbr/>ADVERTISEMENT</span><a href="#FEW_ADVERTISEMENT" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
3535
<div class="tsd-signature">FEW_<wbr/>ADVERTISEMENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
3636
<ul>
37-
<li>Defined in packages/ble/index.common.d.ts:75</li></ul></aside></section>
37+
<li>Defined in packages/ble/index.common.d.ts:78</li></ul></aside></section>
3838
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="MAX_ADVERTISEMENT" class="tsd-anchor"></a>
3939
<h3 class="tsd-anchor-link"><span>MAX_<wbr/>ADVERTISEMENT</span><a href="#MAX_ADVERTISEMENT" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4040
<div class="tsd-signature">MAX_<wbr/>ADVERTISEMENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
4141
<ul>
42-
<li>Defined in packages/ble/index.common.d.ts:74</li></ul></aside></section>
42+
<li>Defined in packages/ble/index.common.d.ts:77</li></ul></aside></section>
4343
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ONE_ADVERTISEMENT" class="tsd-anchor"></a>
4444
<h3 class="tsd-anchor-link"><span>ONE_<wbr/>ADVERTISEMENT</span><a href="#ONE_ADVERTISEMENT" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4545
<div class="tsd-signature">ONE_<wbr/>ADVERTISEMENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
4646
<ul>
47-
<li>Defined in packages/ble/index.common.d.ts:76</li></ul></aside></section></section></div>
47+
<li>Defined in packages/ble/index.common.d.ts:79</li></ul></aside></section></section></div>
4848
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
4949
<div class="tsd-navigation settings">
5050
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/enums/ScanMode.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<li><a href="ScanMode.html">ScanMode</a></li></ul>
1717
<h1>Enumeration ScanMode</h1></div><aside class="tsd-sources">
1818
<ul>
19-
<li>Defined in packages/ble/index.common.d.ts:63</li></ul></aside>
19+
<li>Defined in packages/ble/index.common.d.ts:66</li></ul></aside>
2020
<section class="tsd-panel-group tsd-index-group">
2121
<section class="tsd-panel tsd-index-panel">
2222
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -35,22 +35,22 @@ <h2>Enumeration Members</h2>
3535
<h3 class="tsd-anchor-link"><span>BALANCED</span><a href="#BALANCED" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
3636
<div class="tsd-signature">BALANCED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
3737
<ul>
38-
<li>Defined in packages/ble/index.common.d.ts:65</li></ul></aside></section>
38+
<li>Defined in packages/ble/index.common.d.ts:68</li></ul></aside></section>
3939
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LOW_LATENCY" class="tsd-anchor"></a>
4040
<h3 class="tsd-anchor-link"><span>LOW_<wbr/>LATENCY</span><a href="#LOW_LATENCY" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4141
<div class="tsd-signature">LOW_<wbr/>LATENCY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
4242
<ul>
43-
<li>Defined in packages/ble/index.common.d.ts:64</li></ul></aside></section>
43+
<li>Defined in packages/ble/index.common.d.ts:67</li></ul></aside></section>
4444
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LOW_POWER" class="tsd-anchor"></a>
4545
<h3 class="tsd-anchor-link"><span>LOW_<wbr/>POWER</span><a href="#LOW_POWER" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4646
<div class="tsd-signature">LOW_<wbr/>POWER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
4747
<ul>
48-
<li>Defined in packages/ble/index.common.d.ts:66</li></ul></aside></section>
48+
<li>Defined in packages/ble/index.common.d.ts:69</li></ul></aside></section>
4949
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="OPPORTUNISTIC" class="tsd-anchor"></a>
5050
<h3 class="tsd-anchor-link"><span>OPPORTUNISTIC</span><a href="#OPPORTUNISTIC" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
5151
<div class="tsd-signature">OPPORTUNISTIC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><aside class="tsd-sources">
5252
<ul>
53-
<li>Defined in packages/ble/index.common.d.ts:67</li></ul></aside></section></section></div>
53+
<li>Defined in packages/ble/index.common.d.ts:70</li></ul></aside></section></section></div>
5454
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
5555
<div class="tsd-navigation settings">
5656
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

0 commit comments

Comments
 (0)