Merge pull request #33 from ngrok/bob/0.1.0

0.1.0

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.0:
+
+* Added `ca_cert`, `handle_heartbeat`, and `handle_disconnection` to NgrokSession.
+
 ## 0.0.12:
 
 * Added NgrokSession.close().

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "ngrok-js"
-version = "0.0.12"
+version = "0.1.0"
 
 [lib]
 crate-type = ["cdylib"]

README.md

@@ -14,7 +14,7 @@
 [ci-badge]: https://github.com/ngrok/ngrok-js/actions/workflows/ci.yml/badge.svg
 [ci-url]: https://github.com/ngrok/ngrok-js/actions/workflows/ci.yml
 
-**Note: This is alpha-quality software. Interfaces are subject to change without warning.**
+**Note: This is beta-quality software. Interfaces may change without warning.**
 
 [ngrok](https://ngrok.com) is a globally distributed reverse proxy commonly used for quickly getting a public URL to a
 service running inside a private network, such as on your local laptop. The ngrok agent is usually

RELEASE.md

@@ -10,8 +10,9 @@ Release
 -------
 1. `git checkout main; git pull origin main`
 1. `git checkout -b <username>/<version>`
-1. Bump patch number in `version` in `Cargo.toml`
+1. Bump version number in `version` in `Cargo.toml`
 1. `npm version patch --no-commit-hooks --no-git-tag-version`
+    - Can be 'minor' or 'major' instead of 'patch'
 1. Verify version numbers all match in `git diff --cached`
 1. Update CHANGELOG.md
 1. yarn docs

docs/classes/NgrokHttpTunnel.html

@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">NgrokHttpTunnel</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L137">index.d.ts:137</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L168">index.d.ts:168</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,7 +66,7 @@ <h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Perma
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L168">index.d.ts:168</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L199">index.d.ts:199</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="forwardPipe" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>forward<wbr/>Pipe</span><a href="#forwardPipe" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -83,7 +83,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>addr: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L160">index.d.ts:160</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L191">index.d.ts:191</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="forwardTcp" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>forward<wbr/>Tcp</span><a href="#forwardTcp" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -98,7 +98,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>addr: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L154">index.d.ts:154</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L185">index.d.ts:185</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="forwardsTo" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>forwards<wbr/>To</span><a href="#forwardsTo" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -111,7 +111,7 @@ <h3 class="tsd-anchor-link"><span>forwards<wbr/>To</span><a href="#forwardsTo" a
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L150">index.d.ts:150</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L181">index.d.ts:181</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -121,7 +121,7 @@ <h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink"
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L143">index.d.ts:143</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L174">index.d.ts:174</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="metadata" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>metadata</span><a href="#metadata" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -131,7 +131,7 @@ <h3 class="tsd-anchor-link"><span>metadata</span><a href="#metadata" aria-label=
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L152">index.d.ts:152</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L183">index.d.ts:183</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="proto" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>proto</span><a href="#proto" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -141,7 +141,7 @@ <h3 class="tsd-anchor-link"><span>proto</span><a href="#proto" aria-label="Perma
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L141">index.d.ts:141</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L172">index.d.ts:172</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="url" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>url</span><a href="#url" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -151,7 +151,7 @@ <h3 class="tsd-anchor-link"><span>url</span><a href="#url" aria-label="Permalink
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/6f1b224/index.d.ts#L139">index.d.ts:139</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/ngrok/ngrok-js/blob/b3dca65/index.d.ts#L170">index.d.ts:170</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">