Skip to content

Commit 4113efc

Browse files
author
Marco Crespi
committed
chore(release): 4.0.0
1 parent fdce43a commit 4113efc

27 files changed

+285
-232
lines changed

‎CHANGELOG.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,21 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5-
## [3.0.0](https://github.com/modum-io/modblue/compare/v2.0.3...v3.0.0) (2020-11-10)
5+
## [4.0.0](https://github.com/modum-io/modblue/compare/v3.0.0...v4.0.0) (2020-11-11)
66

77
### ⚠ BREAKING CHANGES
88

9-
- **package:** Change package scope
9+
- Remove some obsolete functions
10+
- Remove characteristic inheritance of EventEmitter
11+
12+
### Features
13+
14+
- **adapter:** Add `scanFor` function ([c176742](https://github.com/modum-io/modblue/commit/c176742a6135dfa8df5d195c8af7fe115216608a))
15+
- **docs:** Add docs for most classes ([0e0d01d](https://github.com/modum-io/modblue/commit/0e0d01de338a8ac3abe4f7b3504262da939b0dd0))
16+
17+
## [3.0.0](https://github.com/modum-io/modblue/compare/v2.0.3...v3.0.0) (2020-11-10)
18+
19+
### ⚠ BREAKING CHANGES
1020

1121
- **package:** Change scope ([35bd780](https://github.com/modum-io/modblue/commit/35bd780ca025b0dd247211a426a9dd02e9ec336c))
1222

‎docs/classes/adapter.html‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Adapter | @modum-io/modblue - v3.0.0</title>
7-
<meta name="description" content="Documentation for @modum-io/modblue - v3.0.0">
6+
<title>Adapter | @modum-io/modblue - v4.0.0</title>
7+
<meta name="description" content="Documentation for @modum-io/modblue - v4.0.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="../index.html" class="title">@modum-io/modblue - v3.0.0</a>
26+
<a href="../index.html" class="title">@modum-io/modblue - v4.0.0</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -52,7 +52,7 @@
5252
<div class="container">
5353
<ul class="tsd-breadcrumb">
5454
<li>
55-
<a href="../modules.html">@modum-io/modblue - v3.0.0</a>
55+
<a href="../modules.html">@modum-io/modblue - v4.0.0</a>
5656
</li>
5757
<li>
5858
<a href="adapter.html">Adapter</a>
@@ -148,7 +148,7 @@ <h3>constructor</h3>
148148
<li class="tsd-description">
149149
<aside class="tsd-sources">
150150
<ul>
151-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L48">src/models/Adapter.ts:48</a></li>
151+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L48">src/models/Adapter.ts:48</a></li>
152152
</ul>
153153
</aside>
154154
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -179,7 +179,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3>
179179
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
180180
<aside class="tsd-sources">
181181
<ul>
182-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L24">src/models/Adapter.ts:24</a></li>
182+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L24">src/models/Adapter.ts:24</a></li>
183183
</ul>
184184
</aside>
185185
<div class="tsd-comment tsd-typography">
@@ -194,7 +194,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> noble</h3>
194194
<div class="tsd-signature tsd-kind-icon">noble<span class="tsd-signature-symbol">:</span> <a href="noble.html" class="tsd-signature-type">Noble</a></div>
195195
<aside class="tsd-sources">
196196
<ul>
197-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L19">src/models/Adapter.ts:19</a></li>
197+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L19">src/models/Adapter.ts:19</a></li>
198198
</ul>
199199
</aside>
200200
<div class="tsd-comment tsd-typography">
@@ -227,7 +227,7 @@ <h3>address</h3>
227227
<li class="tsd-description">
228228
<aside class="tsd-sources">
229229
<ul>
230-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L46">src/models/Adapter.ts:46</a></li>
230+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L46">src/models/Adapter.ts:46</a></li>
231231
</ul>
232232
</aside>
233233
<div class="tsd-comment tsd-typography">
@@ -249,7 +249,7 @@ <h3>address<wbr>Type</h3>
249249
<li class="tsd-description">
250250
<aside class="tsd-sources">
251251
<ul>
252-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L38">src/models/Adapter.ts:38</a></li>
252+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L38">src/models/Adapter.ts:38</a></li>
253253
</ul>
254254
</aside>
255255
<div class="tsd-comment tsd-typography">
@@ -271,7 +271,7 @@ <h3>name</h3>
271271
<li class="tsd-description">
272272
<aside class="tsd-sources">
273273
<ul>
274-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L30">src/models/Adapter.ts:30</a></li>
274+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L30">src/models/Adapter.ts:30</a></li>
275275
</ul>
276276
</aside>
277277
<div class="tsd-comment tsd-typography">
@@ -404,7 +404,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Scanned<wbr>P
404404
<li class="tsd-description">
405405
<aside class="tsd-sources">
406406
<ul>
407-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L130">src/models/Adapter.ts:130</a></li>
407+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L130">src/models/Adapter.ts:130</a></li>
408408
</ul>
409409
</aside>
410410
<div class="tsd-comment tsd-typography">
@@ -426,7 +426,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> is<wbr>Scanning</h3>
426426
<li class="tsd-description">
427427
<aside class="tsd-sources">
428428
<ul>
429-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L113">src/models/Adapter.ts:113</a></li>
429+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L113">src/models/Adapter.ts:113</a></li>
430430
</ul>
431431
</aside>
432432
<div class="tsd-comment tsd-typography">
@@ -754,7 +754,7 @@ <h3>scan<wbr>For</h3>
754754
<li class="tsd-description">
755755
<aside class="tsd-sources">
756756
<ul>
757-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L74">src/models/Adapter.ts:74</a></li>
757+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L74">src/models/Adapter.ts:74</a></li>
758758
</ul>
759759
</aside>
760760
<div class="tsd-comment tsd-typography">
@@ -840,7 +840,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> setup<wbr>Gatt</h3>
840840
<li class="tsd-description">
841841
<aside class="tsd-sources">
842842
<ul>
843-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L147">src/models/Adapter.ts:147</a></li>
843+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L147">src/models/Adapter.ts:147</a></li>
844844
</ul>
845845
</aside>
846846
<div class="tsd-comment tsd-typography">
@@ -871,7 +871,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> start<wbr>Advertising
871871
<li class="tsd-description">
872872
<aside class="tsd-sources">
873873
<ul>
874-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L137">src/models/Adapter.ts:137</a></li>
874+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L137">src/models/Adapter.ts:137</a></li>
875875
</ul>
876876
</aside>
877877
<div class="tsd-comment tsd-typography">
@@ -908,7 +908,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> start<wbr>Scanning</h
908908
<li class="tsd-description">
909909
<aside class="tsd-sources">
910910
<ul>
911-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L121">src/models/Adapter.ts:121</a></li>
911+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L121">src/models/Adapter.ts:121</a></li>
912912
</ul>
913913
</aside>
914914
<div class="tsd-comment tsd-typography">
@@ -946,7 +946,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> stop<wbr>Advertising<
946946
<li class="tsd-description">
947947
<aside class="tsd-sources">
948948
<ul>
949-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L141">src/models/Adapter.ts:141</a></li>
949+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L141">src/models/Adapter.ts:141</a></li>
950950
</ul>
951951
</aside>
952952
<div class="tsd-comment tsd-typography">
@@ -968,7 +968,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> stop<wbr>Scanning</h3
968968
<li class="tsd-description">
969969
<aside class="tsd-sources">
970970
<ul>
971-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L125">src/models/Adapter.ts:125</a></li>
971+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L125">src/models/Adapter.ts:125</a></li>
972972
</ul>
973973
</aside>
974974
<div class="tsd-comment tsd-typography">
@@ -990,7 +990,7 @@ <h3>to<wbr>String</h3>
990990
<li class="tsd-description">
991991
<aside class="tsd-sources">
992992
<ul>
993-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/models/Adapter.ts#L59">src/models/Adapter.ts:59</a></li>
993+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/models/Adapter.ts#L59">src/models/Adapter.ts:59</a></li>
994994
</ul>
995995
</aside>
996996
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>

‎docs/classes/dbusnoble.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>DbusNoble | @modum-io/modblue - v3.0.0</title>
7-
<meta name="description" content="Documentation for @modum-io/modblue - v3.0.0">
6+
<title>DbusNoble | @modum-io/modblue - v4.0.0</title>
7+
<meta name="description" content="Documentation for @modum-io/modblue - v4.0.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="../index.html" class="title">@modum-io/modblue - v3.0.0</a>
26+
<a href="../index.html" class="title">@modum-io/modblue - v4.0.0</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -52,7 +52,7 @@
5252
<div class="container">
5353
<ul class="tsd-breadcrumb">
5454
<li>
55-
<a href="../modules.html">@modum-io/modblue - v3.0.0</a>
55+
<a href="../modules.html">@modum-io/modblue - v4.0.0</a>
5656
</li>
5757
<li>
5858
<a href="dbusnoble.html">DbusNoble</a>
@@ -124,7 +124,7 @@ <h3>constructor</h3>
124124
<li class="tsd-description">
125125
<aside class="tsd-sources">
126126
<ul>
127-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/bindings/dbus/Noble.ts#L15">src/bindings/dbus/Noble.ts:15</a></li>
127+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/bindings/dbus/Noble.ts#L15">src/bindings/dbus/Noble.ts:15</a></li>
128128
</ul>
129129
</aside>
130130
<h4 class="tsd-returns-title">Returns <a href="dbusnoble.html" class="tsd-signature-type">DbusNoble</a></h4>
@@ -140,7 +140,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dbus</h3>
140140
<div class="tsd-signature tsd-kind-icon">dbus<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MessageBus</span></div>
141141
<aside class="tsd-sources">
142142
<ul>
143-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/bindings/dbus/Noble.ts#L12">src/bindings/dbus/Noble.ts:12</a></li>
143+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/bindings/dbus/Noble.ts#L12">src/bindings/dbus/Noble.ts:12</a></li>
144144
</ul>
145145
</aside>
146146
</section>
@@ -158,7 +158,7 @@ <h3>dispose</h3>
158158
<aside class="tsd-sources">
159159
<p>Overrides <a href="noble.html">Noble</a>.<a href="noble.html#dispose">dispose</a></p>
160160
<ul>
161-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/bindings/dbus/Noble.ts#L27">src/bindings/dbus/Noble.ts:27</a></li>
161+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/bindings/dbus/Noble.ts#L27">src/bindings/dbus/Noble.ts:27</a></li>
162162
</ul>
163163
</aside>
164164
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span></h4>
@@ -176,7 +176,7 @@ <h3>get<wbr>Adapters</h3>
176176
<aside class="tsd-sources">
177177
<p>Overrides <a href="noble.html">Noble</a>.<a href="noble.html#getadapters">getAdapters</a></p>
178178
<ul>
179-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/bindings/dbus/Noble.ts#L31">src/bindings/dbus/Noble.ts:31</a></li>
179+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/bindings/dbus/Noble.ts#L31">src/bindings/dbus/Noble.ts:31</a></li>
180180
</ul>
181181
</aside>
182182
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="adapter.html" class="tsd-signature-type">Adapter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -194,7 +194,7 @@ <h3>init</h3>
194194
<aside class="tsd-sources">
195195
<p>Overrides <a href="noble.html">Noble</a>.<a href="noble.html#init">init</a></p>
196196
<ul>
197-
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/845069e/src/bindings/dbus/Noble.ts#L23">src/bindings/dbus/Noble.ts:23</a></li>
197+
<li>Defined in <a href="https://github.com/modum-io/modblue/blob/fdce43a/src/bindings/dbus/Noble.ts#L23">src/bindings/dbus/Noble.ts:23</a></li>
198198
</ul>
199199
</aside>
200200
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span></h4>

‎docs/classes/gatt.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Gatt | @modum-io/modblue - v3.0.0</title>
7-
<meta name="description" content="Documentation for @modum-io/modblue - v3.0.0">
6+
<title>Gatt | @modum-io/modblue - v4.0.0</title>
7+
<meta name="description" content="Documentation for @modum-io/modblue - v4.0.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="../index.html" class="title">@modum-io/modblue - v3.0.0</a>
26+
<a href="../index.html" class="title">@modum-io/modblue - v4.0.0</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -52,7 +52,7 @@
5252
<div class="container">
5353
<ul class="tsd-breadcrumb">
5454
<li>
55-
<a href="../modules.html">@modum-io/modblue - v3.0.0</a>
55+
<a href="../modules.html">@modum-io/modblue - v4.0.0</a>
5656
</li>
5757
<li>
5858
<a href="gatt.html">Gatt</a>

0 commit comments

Comments
 (0)