Bump version to 2.0.0

albert-team · Aug 22, 2019 · 5a93512 · 5a93512
1 parent a349213
commit 5a93512
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 65 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v2.0.0
+
+### FEATURES
+
+- Add _Typedoc_ and generate API documentation
+
+### PATCHES
+
+- Upgrade [_Red_](https://github.com/albert-team/red) dependency to fix compatibility issue with Node < v9.11.0
+
 ## v2.0.0-canary.0
 
 ### FEATURES

diff --git a/README.md b/README.md
@@ -18,13 +18,13 @@
 #### With `npm`
 
 ```bash
-npm i @albert-team/rebloom@canary
+npm i @albert-team/rebloom
 ```
 
 #### With `yarn`
 
 ```bash
-yarn add @albert-team/rebloom@canary
+yarn add @albert-team/rebloom
 ```
 
 ## Usage
@@ -53,6 +53,10 @@ const main = async () => {
 main()
 ```
 
+### API
+
+Read more [here](https://albert-team.github.io/rebloom).
+
 ## Changelog
 
 Read more [here](https://github.com/albert-team/rebloom/blob/master/CHANGELOG.md).

diff --git a/docs/classes/basefilter.html b/docs/classes/basefilter.html
@@ -132,7 +132,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L10">base-filter.ts:10</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L10">base-filter.ts:10</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -169,7 +169,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> client</h3>
 					<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Red</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L10">base-filter.ts:10</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L10">base-filter.ts:10</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -179,7 +179,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> name</h3>
 					<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L8">base-filter.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L8">base-filter.ts:8</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -189,7 +189,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> options</h3>
 					<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="options.html" class="tsd-signature-type">Options</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L9">base-filter.ts:9</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L9">base-filter.ts:9</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -206,7 +206,7 @@ <h3>connect</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L27">base-filter.ts:27</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L27">base-filter.ts:27</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -228,7 +228,7 @@ <h3>disconnect</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L34">base-filter.ts:34</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L34">base-filter.ts:34</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -250,7 +250,7 @@ <h3>reset</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L42">base-filter.ts:42</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L42">base-filter.ts:42</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/bloomfilter.html b/docs/classes/bloomfilter.html
@@ -127,7 +127,7 @@ <h3>constructor</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#constructor">constructor</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L10">base-filter.ts:10</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L10">base-filter.ts:10</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> client</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#client">client</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L10">base-filter.ts:10</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L10">base-filter.ts:10</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -176,7 +176,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> name</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#name">name</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L8">base-filter.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L8">base-filter.ts:8</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -187,7 +187,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> options</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#options">options</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L9">base-filter.ts:9</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L9">base-filter.ts:9</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -204,7 +204,7 @@ <h3>add</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/bloom-filter.ts#L22">bloom-filter.ts:22</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/bloom-filter.ts#L22">bloom-filter.ts:22</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -237,7 +237,7 @@ <h3>connect</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#connect">connect</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L27">base-filter.ts:27</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L27">base-filter.ts:27</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -260,7 +260,7 @@ <h3>disconnect</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#disconnect">disconnect</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L34">base-filter.ts:34</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L34">base-filter.ts:34</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -282,7 +282,7 @@ <h3>exists</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/bloom-filter.ts#L31">bloom-filter.ts:31</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/bloom-filter.ts#L31">bloom-filter.ts:31</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -314,7 +314,7 @@ <h3>reserve</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/bloom-filter.ts#L13">bloom-filter.ts:13</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/bloom-filter.ts#L13">bloom-filter.ts:13</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -353,7 +353,7 @@ <h3>reset</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#reset">reset</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L42">base-filter.ts:42</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L42">base-filter.ts:42</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/countminsketch.html b/docs/classes/countminsketch.html
@@ -128,7 +128,7 @@ <h3>constructor</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#constructor">constructor</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L10">base-filter.ts:10</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L10">base-filter.ts:10</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -166,7 +166,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> client</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#client">client</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L10">base-filter.ts:10</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L10">base-filter.ts:10</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -177,7 +177,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> name</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#name">name</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L8">base-filter.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L8">base-filter.ts:8</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -188,7 +188,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> options</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#options">options</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L9">base-filter.ts:9</a></li>
+							<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L9">base-filter.ts:9</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -205,7 +205,7 @@ <h3>add</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/count-min-sketch.ts#L33">count-min-sketch.ts:33</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/count-min-sketch.ts#L33">count-min-sketch.ts:33</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -244,7 +244,7 @@ <h3>connect</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#connect">connect</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L27">base-filter.ts:27</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L27">base-filter.ts:27</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -266,7 +266,7 @@ <h3>count</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/count-min-sketch.ts#L43">count-min-sketch.ts:43</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/count-min-sketch.ts#L43">count-min-sketch.ts:43</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -300,7 +300,7 @@ <h3>disconnect</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#disconnect">disconnect</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L34">base-filter.ts:34</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L34">base-filter.ts:34</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -322,7 +322,7 @@ <h3>from<wbr>Dimensions</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/count-min-sketch.ts#L13">count-min-sketch.ts:13</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/count-min-sketch.ts#L13">count-min-sketch.ts:13</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -360,7 +360,7 @@ <h3>from<wbr>Probability</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/count-min-sketch.ts#L23">count-min-sketch.ts:23</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/count-min-sketch.ts#L23">count-min-sketch.ts:23</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -399,7 +399,7 @@ <h3>reset</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="basefilter.html">BaseFilter</a>.<a href="basefilter.html#reset">reset</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/1962756/src/base-filter.ts#L42">base-filter.ts:42</a></li>
+									<li>Defined in <a href="https://github.com/albert-team/rebloom/blob/ad600ae/src/base-filter.ts#L42">base-filter.ts:42</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">