From f2adade691230b3a7ac013731f78d525b651ae02 Mon Sep 17 00:00:00 2001 From: bobzilladev Date: Wed, 29 Mar 2023 08:39:54 -0400 Subject: [PATCH] 0.1.0 --- CHANGELOG.md | 4 + Cargo.toml | 2 +- README.md | 2 +- RELEASE.md | 3 +- docs/assets/search.js | 2 +- docs/classes/NgrokHttpTunnel.html | 18 ++-- docs/classes/NgrokHttpTunnelBuilder.html | 42 ++++---- docs/classes/NgrokLabeledTunnel.html | 16 +-- docs/classes/NgrokLabeledTunnelBuilder.html | 8 +- docs/classes/NgrokSession.html | 26 +++-- docs/classes/NgrokSessionBuilder.html | 112 +++++++++++++++++--- docs/classes/NgrokTcpTunnel.html | 18 ++-- docs/classes/NgrokTcpTunnelBuilder.html | 16 +-- docs/classes/NgrokTlsTunnel.html | 18 ++-- docs/classes/NgrokTlsTunnelBuilder.html | 20 ++-- docs/classes/UpdateRequest.html | 6 +- docs/functions/consoleLog.html | 2 +- docs/functions/listen.html | 2 +- docs/functions/listenable.html | 2 +- docs/functions/loggingCallback.html | 2 +- docs/index.html | 3 +- npm/android-arm-eabi/package.json | 2 +- npm/android-arm64/package.json | 2 +- npm/darwin-arm64/package.json | 2 +- npm/darwin-universal/package.json | 2 +- npm/darwin-x64/package.json | 2 +- npm/freebsd-x64/package.json | 2 +- npm/linux-arm-gnueabihf/package.json | 2 +- npm/linux-arm64-gnu/package.json | 2 +- npm/linux-arm64-musl/package.json | 2 +- npm/linux-x64-gnu/package.json | 2 +- npm/linux-x64-musl/package.json | 2 +- npm/win32-arm64-msvc/package.json | 2 +- npm/win32-ia32-msvc/package.json | 2 +- npm/win32-x64-msvc/package.json | 2 +- package.json | 2 +- 36 files changed, 229 insertions(+), 125 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a5ec88..6eaa99d 100644 --- a/CHANGELOG.md +++ b/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(). diff --git a/Cargo.toml b/Cargo.toml index 4356865..5fbfa77 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] edition = "2021" name = "ngrok-js" -version = "0.0.12" +version = "0.1.0" [lib] crate-type = ["cdylib"] diff --git a/README.md b/README.md index 2bdf80e..310fd3b 100644 --- a/README.md +++ b/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 diff --git a/RELEASE.md b/RELEASE.md index 4edbfe3..6f492ff 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -10,8 +10,9 @@ Release ------- 1. `git checkout main; git pull origin main` 1. `git checkout -b /` -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 diff --git a/docs/assets/search.js b/docs/assets/search.js index 768ea89..ffd52ae 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\"},\"rows\":[{\"kind\":64,\"name\":\"loggingCallback\",\"url\":\"functions/loggingCallback.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"listenable\",\"url\":\"functions/listenable.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"listen\",\"url\":\"functions/listen.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"consoleLog\",\"url\":\"functions/consoleLog.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":128,\"name\":\"NgrokSessionBuilder\",\"url\":\"classes/NgrokSessionBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokSessionBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"authtoken\",\"url\":\"classes/NgrokSessionBuilder.html#authtoken\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"authtokenFromEnv\",\"url\":\"classes/NgrokSessionBuilder.html#authtokenFromEnv\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"heartbeatInterval\",\"url\":\"classes/NgrokSessionBuilder.html#heartbeatInterval\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"heartbeatTolerance\",\"url\":\"classes/NgrokSessionBuilder.html#heartbeatTolerance\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokSessionBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"serverAddr\",\"url\":\"classes/NgrokSessionBuilder.html#serverAddr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleStopCommand\",\"url\":\"classes/NgrokSessionBuilder.html#handleStopCommand\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleRestartCommand\",\"url\":\"classes/NgrokSessionBuilder.html#handleRestartCommand\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleUpdateCommand\",\"url\":\"classes/NgrokSessionBuilder.html#handleUpdateCommand\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"connect\",\"url\":\"classes/NgrokSessionBuilder.html#connect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":128,\"name\":\"NgrokSession\",\"url\":\"classes/NgrokSession.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokSession.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"httpEndpoint\",\"url\":\"classes/NgrokSession.html#httpEndpoint\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"tcpEndpoint\",\"url\":\"classes/NgrokSession.html#tcpEndpoint\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"tlsEndpoint\",\"url\":\"classes/NgrokSession.html#tlsEndpoint\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"labeledTunnel\",\"url\":\"classes/NgrokSession.html#labeledTunnel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"closeTunnel\",\"url\":\"classes/NgrokSession.html#closeTunnel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":128,\"name\":\"UpdateRequest\",\"url\":\"classes/UpdateRequest.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/UpdateRequest.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"UpdateRequest\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"classes/UpdateRequest.html#version\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UpdateRequest\"},{\"kind\":1024,\"name\":\"permitMajorVersion\",\"url\":\"classes/UpdateRequest.html#permitMajorVersion\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UpdateRequest\"},{\"kind\":128,\"name\":\"NgrokHttpTunnel\",\"url\":\"classes/NgrokHttpTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokHttpTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"url\",\"url\":\"classes/NgrokHttpTunnel.html#url\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"proto\",\"url\":\"classes/NgrokHttpTunnel.html#proto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokHttpTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokHttpTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokHttpTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokHttpTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokHttpTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokHttpTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":128,\"name\":\"NgrokTcpTunnel\",\"url\":\"classes/NgrokTcpTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTcpTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"url\",\"url\":\"classes/NgrokTcpTunnel.html#url\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"proto\",\"url\":\"classes/NgrokTcpTunnel.html#proto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokTcpTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTcpTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTcpTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokTcpTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokTcpTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokTcpTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":128,\"name\":\"NgrokTlsTunnel\",\"url\":\"classes/NgrokTlsTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTlsTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"url\",\"url\":\"classes/NgrokTlsTunnel.html#url\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"proto\",\"url\":\"classes/NgrokTlsTunnel.html#proto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokTlsTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTlsTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTlsTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokTlsTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokTlsTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokTlsTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":128,\"name\":\"NgrokLabeledTunnel\",\"url\":\"classes/NgrokLabeledTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokLabeledTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"labels\",\"url\":\"classes/NgrokLabeledTunnel.html#labels\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokLabeledTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokLabeledTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokLabeledTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokLabeledTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokLabeledTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokLabeledTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":128,\"name\":\"NgrokHttpTunnelBuilder\",\"url\":\"classes/NgrokHttpTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"scheme\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#scheme\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"domain\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#domain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"mutualTlsca\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#mutualTlsca\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"compression\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#compression\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"websocketTcpConversion\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#websocketTcpConversion\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"circuitBreaker\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#circuitBreaker\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"requestHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#requestHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"responseHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#responseHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"removeRequestHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#removeRequestHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"removeResponseHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#removeResponseHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"basicAuth\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#basicAuth\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"oauth\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#oauth\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"oidc\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#oidc\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"webhookVerification\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#webhookVerification\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"allowCidr\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#allowCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"denyCidr\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#denyCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"proxyProto\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#proxyProto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":128,\"name\":\"NgrokTcpTunnelBuilder\",\"url\":\"classes/NgrokTcpTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"remoteAddr\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#remoteAddr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"allowCidr\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#allowCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"denyCidr\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#denyCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"proxyProto\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#proxyProto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":128,\"name\":\"NgrokTlsTunnelBuilder\",\"url\":\"classes/NgrokTlsTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"domain\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#domain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"mutualTlsca\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#mutualTlsca\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"termination\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#termination\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"allowCidr\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#allowCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"denyCidr\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#denyCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"proxyProto\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#proxyProto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":128,\"name\":\"NgrokLabeledTunnelBuilder\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"},{\"kind\":2048,\"name\":\"label\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#label\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,43.307]],[\"comment/0\",[]],[\"name/1\",[1,43.307]],[\"comment/1\",[]],[\"name/2\",[2,30.315]],[\"comment/2\",[]],[\"name/3\",[3,43.307]],[\"comment/3\",[]],[\"name/4\",[4,43.307]],[\"comment/4\",[]],[\"name/5\",[5,22.939]],[\"comment/5\",[]],[\"name/6\",[6,43.307]],[\"comment/6\",[]],[\"name/7\",[7,43.307]],[\"comment/7\",[]],[\"name/8\",[8,43.307]],[\"comment/8\",[]],[\"name/9\",[9,43.307]],[\"comment/9\",[]],[\"name/10\",[10,24.849]],[\"comment/10\",[]],[\"name/11\",[11,43.307]],[\"comment/11\",[]],[\"name/12\",[12,43.307]],[\"comment/12\",[]],[\"name/13\",[13,43.307]],[\"comment/13\",[]],[\"name/14\",[14,43.307]],[\"comment/14\",[]],[\"name/15\",[15,43.307]],[\"comment/15\",[]],[\"name/16\",[16,43.307]],[\"comment/16\",[]],[\"name/17\",[5,22.939]],[\"comment/17\",[]],[\"name/18\",[17,43.307]],[\"comment/18\",[]],[\"name/19\",[18,43.307]],[\"comment/19\",[]],[\"name/20\",[19,43.307]],[\"comment/20\",[]],[\"name/21\",[20,43.307]],[\"comment/21\",[]],[\"name/22\",[21,43.307]],[\"comment/22\",[]],[\"name/23\",[22,43.307]],[\"comment/23\",[]],[\"name/24\",[5,22.939]],[\"comment/24\",[]],[\"name/25\",[23,43.307]],[\"comment/25\",[]],[\"name/26\",[24,43.307]],[\"comment/26\",[]],[\"name/27\",[25,43.307]],[\"comment/27\",[]],[\"name/28\",[5,22.939]],[\"comment/28\",[]],[\"name/29\",[26,34.834]],[\"comment/29\",[]],[\"name/30\",[27,34.834]],[\"comment/30\",[]],[\"name/31\",[28,32.321]],[\"comment/31\",[]],[\"name/32\",[29,27.213]],[\"comment/32\",[]],[\"name/33\",[10,24.849]],[\"comment/33\",[]],[\"name/34\",[30,32.321]],[\"comment/34\",[]],[\"name/35\",[31,32.321]],[\"comment/35\",[]],[\"name/36\",[32,32.321]],[\"comment/36\",[]],[\"name/37\",[33,43.307]],[\"comment/37\",[]],[\"name/38\",[5,22.939]],[\"comment/38\",[]],[\"name/39\",[26,34.834]],[\"comment/39\",[]],[\"name/40\",[27,34.834]],[\"comment/40\",[]],[\"name/41\",[28,32.321]],[\"comment/41\",[]],[\"name/42\",[29,27.213]],[\"comment/42\",[]],[\"name/43\",[10,24.849]],[\"comment/43\",[]],[\"name/44\",[30,32.321]],[\"comment/44\",[]],[\"name/45\",[31,32.321]],[\"comment/45\",[]],[\"name/46\",[32,32.321]],[\"comment/46\",[]],[\"name/47\",[34,43.307]],[\"comment/47\",[]],[\"name/48\",[5,22.939]],[\"comment/48\",[]],[\"name/49\",[26,34.834]],[\"comment/49\",[]],[\"name/50\",[27,34.834]],[\"comment/50\",[]],[\"name/51\",[28,32.321]],[\"comment/51\",[]],[\"name/52\",[29,27.213]],[\"comment/52\",[]],[\"name/53\",[10,24.849]],[\"comment/53\",[]],[\"name/54\",[30,32.321]],[\"comment/54\",[]],[\"name/55\",[31,32.321]],[\"comment/55\",[]],[\"name/56\",[32,32.321]],[\"comment/56\",[]],[\"name/57\",[35,43.307]],[\"comment/57\",[]],[\"name/58\",[5,22.939]],[\"comment/58\",[]],[\"name/59\",[36,43.307]],[\"comment/59\",[]],[\"name/60\",[28,32.321]],[\"comment/60\",[]],[\"name/61\",[29,27.213]],[\"comment/61\",[]],[\"name/62\",[10,24.849]],[\"comment/62\",[]],[\"name/63\",[30,32.321]],[\"comment/63\",[]],[\"name/64\",[31,32.321]],[\"comment/64\",[]],[\"name/65\",[32,32.321]],[\"comment/65\",[]],[\"name/66\",[37,43.307]],[\"comment/66\",[]],[\"name/67\",[5,22.939]],[\"comment/67\",[]],[\"name/68\",[38,43.307]],[\"comment/68\",[]],[\"name/69\",[39,38.199]],[\"comment/69\",[]],[\"name/70\",[40,38.199]],[\"comment/70\",[]],[\"name/71\",[41,43.307]],[\"comment/71\",[]],[\"name/72\",[42,43.307]],[\"comment/72\",[]],[\"name/73\",[43,43.307]],[\"comment/73\",[]],[\"name/74\",[44,43.307]],[\"comment/74\",[]],[\"name/75\",[45,43.307]],[\"comment/75\",[]],[\"name/76\",[46,43.307]],[\"comment/76\",[]],[\"name/77\",[47,43.307]],[\"comment/77\",[]],[\"name/78\",[48,43.307]],[\"comment/78\",[]],[\"name/79\",[49,43.307]],[\"comment/79\",[]],[\"name/80\",[50,43.307]],[\"comment/80\",[]],[\"name/81\",[51,43.307]],[\"comment/81\",[]],[\"name/82\",[10,24.849]],[\"comment/82\",[]],[\"name/83\",[2,30.315]],[\"comment/83\",[]],[\"name/84\",[52,34.834]],[\"comment/84\",[]],[\"name/85\",[53,34.834]],[\"comment/85\",[]],[\"name/86\",[54,34.834]],[\"comment/86\",[]],[\"name/87\",[29,27.213]],[\"comment/87\",[]],[\"name/88\",[55,43.307]],[\"comment/88\",[]],[\"name/89\",[5,22.939]],[\"comment/89\",[]],[\"name/90\",[56,43.307]],[\"comment/90\",[]],[\"name/91\",[10,24.849]],[\"comment/91\",[]],[\"name/92\",[2,30.315]],[\"comment/92\",[]],[\"name/93\",[52,34.834]],[\"comment/93\",[]],[\"name/94\",[53,34.834]],[\"comment/94\",[]],[\"name/95\",[54,34.834]],[\"comment/95\",[]],[\"name/96\",[29,27.213]],[\"comment/96\",[]],[\"name/97\",[57,43.307]],[\"comment/97\",[]],[\"name/98\",[5,22.939]],[\"comment/98\",[]],[\"name/99\",[39,38.199]],[\"comment/99\",[]],[\"name/100\",[40,38.199]],[\"comment/100\",[]],[\"name/101\",[58,43.307]],[\"comment/101\",[]],[\"name/102\",[10,24.849]],[\"comment/102\",[]],[\"name/103\",[2,30.315]],[\"comment/103\",[]],[\"name/104\",[52,34.834]],[\"comment/104\",[]],[\"name/105\",[53,34.834]],[\"comment/105\",[]],[\"name/106\",[54,34.834]],[\"comment/106\",[]],[\"name/107\",[29,27.213]],[\"comment/107\",[]],[\"name/108\",[59,43.307]],[\"comment/108\",[]],[\"name/109\",[5,22.939]],[\"comment/109\",[]],[\"name/110\",[10,24.849]],[\"comment/110\",[]],[\"name/111\",[2,30.315]],[\"comment/111\",[]],[\"name/112\",[60,43.307]],[\"comment/112\",[]]],\"invertedIndex\":[[\"allowcidr\",{\"_index\":52,\"name\":{\"84\":{},\"93\":{},\"104\":{}},\"comment\":{}}],[\"authtoken\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"authtokenfromenv\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"basicauth\",{\"_index\":48,\"name\":{\"78\":{}},\"comment\":{}}],[\"circuitbreaker\",{\"_index\":43,\"name\":{\"73\":{}},\"comment\":{}}],[\"close\",{\"_index\":32,\"name\":{\"36\":{},\"46\":{},\"56\":{},\"65\":{}},\"comment\":{}}],[\"closetunnel\",{\"_index\":21,\"name\":{\"22\":{}},\"comment\":{}}],[\"compression\",{\"_index\":41,\"name\":{\"71\":{}},\"comment\":{}}],[\"connect\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"consolelog\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":5,\"name\":{\"5\":{},\"17\":{},\"24\":{},\"28\":{},\"38\":{},\"48\":{},\"58\":{},\"67\":{},\"89\":{},\"98\":{},\"109\":{}},\"comment\":{}}],[\"denycidr\",{\"_index\":53,\"name\":{\"85\":{},\"94\":{},\"105\":{}},\"comment\":{}}],[\"domain\",{\"_index\":39,\"name\":{\"69\":{},\"99\":{}},\"comment\":{}}],[\"forwardpipe\",{\"_index\":31,\"name\":{\"35\":{},\"45\":{},\"55\":{},\"64\":{}},\"comment\":{}}],[\"forwardsto\",{\"_index\":29,\"name\":{\"32\":{},\"42\":{},\"52\":{},\"61\":{},\"87\":{},\"96\":{},\"107\":{}},\"comment\":{}}],[\"forwardtcp\",{\"_index\":30,\"name\":{\"34\":{},\"44\":{},\"54\":{},\"63\":{}},\"comment\":{}}],[\"handlerestartcommand\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"handlestopcommand\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"handleupdatecommand\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"heartbeatinterval\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"heartbeattolerance\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"httpendpoint\",{\"_index\":17,\"name\":{\"18\":{}},\"comment\":{}}],[\"id\",{\"_index\":28,\"name\":{\"31\":{},\"41\":{},\"51\":{},\"60\":{}},\"comment\":{}}],[\"label\",{\"_index\":60,\"name\":{\"112\":{}},\"comment\":{}}],[\"labeledtunnel\",{\"_index\":20,\"name\":{\"21\":{}},\"comment\":{}}],[\"labels\",{\"_index\":36,\"name\":{\"59\":{}},\"comment\":{}}],[\"listen\",{\"_index\":2,\"name\":{\"2\":{},\"83\":{},\"92\":{},\"103\":{},\"111\":{}},\"comment\":{}}],[\"listenable\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"loggingcallback\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"metadata\",{\"_index\":10,\"name\":{\"10\":{},\"33\":{},\"43\":{},\"53\":{},\"62\":{},\"82\":{},\"91\":{},\"102\":{},\"110\":{}},\"comment\":{}}],[\"mutualtlsca\",{\"_index\":40,\"name\":{\"70\":{},\"100\":{}},\"comment\":{}}],[\"ngrokhttptunnel\",{\"_index\":25,\"name\":{\"27\":{}},\"comment\":{}}],[\"ngrokhttptunnelbuilder\",{\"_index\":37,\"name\":{\"66\":{}},\"comment\":{}}],[\"ngroklabeledtunnel\",{\"_index\":35,\"name\":{\"57\":{}},\"comment\":{}}],[\"ngroklabeledtunnelbuilder\",{\"_index\":59,\"name\":{\"108\":{}},\"comment\":{}}],[\"ngroksession\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"ngroksessionbuilder\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"ngroktcptunnel\",{\"_index\":33,\"name\":{\"37\":{}},\"comment\":{}}],[\"ngroktcptunnelbuilder\",{\"_index\":55,\"name\":{\"88\":{}},\"comment\":{}}],[\"ngroktlstunnel\",{\"_index\":34,\"name\":{\"47\":{}},\"comment\":{}}],[\"ngroktlstunnelbuilder\",{\"_index\":57,\"name\":{\"97\":{}},\"comment\":{}}],[\"oauth\",{\"_index\":49,\"name\":{\"79\":{}},\"comment\":{}}],[\"oidc\",{\"_index\":50,\"name\":{\"80\":{}},\"comment\":{}}],[\"permitmajorversion\",{\"_index\":24,\"name\":{\"26\":{}},\"comment\":{}}],[\"proto\",{\"_index\":27,\"name\":{\"30\":{},\"40\":{},\"50\":{}},\"comment\":{}}],[\"proxyproto\",{\"_index\":54,\"name\":{\"86\":{},\"95\":{},\"106\":{}},\"comment\":{}}],[\"remoteaddr\",{\"_index\":56,\"name\":{\"90\":{}},\"comment\":{}}],[\"removerequestheader\",{\"_index\":46,\"name\":{\"76\":{}},\"comment\":{}}],[\"removeresponseheader\",{\"_index\":47,\"name\":{\"77\":{}},\"comment\":{}}],[\"requestheader\",{\"_index\":44,\"name\":{\"74\":{}},\"comment\":{}}],[\"responseheader\",{\"_index\":45,\"name\":{\"75\":{}},\"comment\":{}}],[\"scheme\",{\"_index\":38,\"name\":{\"68\":{}},\"comment\":{}}],[\"serveraddr\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"tcpendpoint\",{\"_index\":18,\"name\":{\"19\":{}},\"comment\":{}}],[\"termination\",{\"_index\":58,\"name\":{\"101\":{}},\"comment\":{}}],[\"tlsendpoint\",{\"_index\":19,\"name\":{\"20\":{}},\"comment\":{}}],[\"updaterequest\",{\"_index\":22,\"name\":{\"23\":{}},\"comment\":{}}],[\"url\",{\"_index\":26,\"name\":{\"29\":{},\"39\":{},\"49\":{}},\"comment\":{}}],[\"version\",{\"_index\":23,\"name\":{\"25\":{}},\"comment\":{}}],[\"webhookverification\",{\"_index\":51,\"name\":{\"81\":{}},\"comment\":{}}],[\"websockettcpconversion\",{\"_index\":42,\"name\":{\"72\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\"},\"rows\":[{\"kind\":64,\"name\":\"loggingCallback\",\"url\":\"functions/loggingCallback.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"listenable\",\"url\":\"functions/listenable.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"listen\",\"url\":\"functions/listen.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"consoleLog\",\"url\":\"functions/consoleLog.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":128,\"name\":\"NgrokSessionBuilder\",\"url\":\"classes/NgrokSessionBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokSessionBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"authtoken\",\"url\":\"classes/NgrokSessionBuilder.html#authtoken\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"authtokenFromEnv\",\"url\":\"classes/NgrokSessionBuilder.html#authtokenFromEnv\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"heartbeatInterval\",\"url\":\"classes/NgrokSessionBuilder.html#heartbeatInterval\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"heartbeatTolerance\",\"url\":\"classes/NgrokSessionBuilder.html#heartbeatTolerance\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokSessionBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"serverAddr\",\"url\":\"classes/NgrokSessionBuilder.html#serverAddr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"caCert\",\"url\":\"classes/NgrokSessionBuilder.html#caCert\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleDisconnection\",\"url\":\"classes/NgrokSessionBuilder.html#handleDisconnection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleStopCommand\",\"url\":\"classes/NgrokSessionBuilder.html#handleStopCommand\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleRestartCommand\",\"url\":\"classes/NgrokSessionBuilder.html#handleRestartCommand\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleUpdateCommand\",\"url\":\"classes/NgrokSessionBuilder.html#handleUpdateCommand\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"handleHeartbeat\",\"url\":\"classes/NgrokSessionBuilder.html#handleHeartbeat\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":2048,\"name\":\"connect\",\"url\":\"classes/NgrokSessionBuilder.html#connect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSessionBuilder\"},{\"kind\":128,\"name\":\"NgrokSession\",\"url\":\"classes/NgrokSession.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokSession.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"httpEndpoint\",\"url\":\"classes/NgrokSession.html#httpEndpoint\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"tcpEndpoint\",\"url\":\"classes/NgrokSession.html#tcpEndpoint\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"tlsEndpoint\",\"url\":\"classes/NgrokSession.html#tlsEndpoint\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"labeledTunnel\",\"url\":\"classes/NgrokSession.html#labeledTunnel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"closeTunnel\",\"url\":\"classes/NgrokSession.html#closeTunnel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokSession.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokSession\"},{\"kind\":128,\"name\":\"UpdateRequest\",\"url\":\"classes/UpdateRequest.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/UpdateRequest.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"UpdateRequest\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"classes/UpdateRequest.html#version\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UpdateRequest\"},{\"kind\":1024,\"name\":\"permitMajorVersion\",\"url\":\"classes/UpdateRequest.html#permitMajorVersion\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"UpdateRequest\"},{\"kind\":128,\"name\":\"NgrokHttpTunnel\",\"url\":\"classes/NgrokHttpTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokHttpTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"url\",\"url\":\"classes/NgrokHttpTunnel.html#url\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"proto\",\"url\":\"classes/NgrokHttpTunnel.html#proto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokHttpTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokHttpTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokHttpTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokHttpTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokHttpTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokHttpTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnel\"},{\"kind\":128,\"name\":\"NgrokTcpTunnel\",\"url\":\"classes/NgrokTcpTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTcpTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"url\",\"url\":\"classes/NgrokTcpTunnel.html#url\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"proto\",\"url\":\"classes/NgrokTcpTunnel.html#proto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokTcpTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTcpTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTcpTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokTcpTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokTcpTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokTcpTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnel\"},{\"kind\":128,\"name\":\"NgrokTlsTunnel\",\"url\":\"classes/NgrokTlsTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTlsTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"url\",\"url\":\"classes/NgrokTlsTunnel.html#url\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"proto\",\"url\":\"classes/NgrokTlsTunnel.html#proto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokTlsTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTlsTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTlsTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokTlsTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokTlsTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokTlsTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnel\"},{\"kind\":128,\"name\":\"NgrokLabeledTunnel\",\"url\":\"classes/NgrokLabeledTunnel.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokLabeledTunnel.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"labels\",\"url\":\"classes/NgrokLabeledTunnel.html#labels\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"id\",\"url\":\"classes/NgrokLabeledTunnel.html#id\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokLabeledTunnel.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokLabeledTunnel.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"forwardTcp\",\"url\":\"classes/NgrokLabeledTunnel.html#forwardTcp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"forwardPipe\",\"url\":\"classes/NgrokLabeledTunnel.html#forwardPipe\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/NgrokLabeledTunnel.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnel\"},{\"kind\":128,\"name\":\"NgrokHttpTunnelBuilder\",\"url\":\"classes/NgrokHttpTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"scheme\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#scheme\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"domain\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#domain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"mutualTlsca\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#mutualTlsca\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"compression\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#compression\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"websocketTcpConversion\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#websocketTcpConversion\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"circuitBreaker\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#circuitBreaker\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"requestHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#requestHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"responseHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#responseHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"removeRequestHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#removeRequestHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"removeResponseHeader\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#removeResponseHeader\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"basicAuth\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#basicAuth\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"oauth\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#oauth\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"oidc\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#oidc\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"webhookVerification\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#webhookVerification\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"allowCidr\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#allowCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"denyCidr\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#denyCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"proxyProto\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#proxyProto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokHttpTunnelBuilder.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokHttpTunnelBuilder\"},{\"kind\":128,\"name\":\"NgrokTcpTunnelBuilder\",\"url\":\"classes/NgrokTcpTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"remoteAddr\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#remoteAddr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"allowCidr\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#allowCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"denyCidr\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#denyCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"proxyProto\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#proxyProto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTcpTunnelBuilder.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTcpTunnelBuilder\"},{\"kind\":128,\"name\":\"NgrokTlsTunnelBuilder\",\"url\":\"classes/NgrokTlsTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"domain\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#domain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"mutualTlsca\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#mutualTlsca\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"termination\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#termination\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"allowCidr\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#allowCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"denyCidr\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#denyCidr\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"proxyProto\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#proxyProto\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":2048,\"name\":\"forwardsTo\",\"url\":\"classes/NgrokTlsTunnelBuilder.html#forwardsTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokTlsTunnelBuilder\"},{\"kind\":128,\"name\":\"NgrokLabeledTunnelBuilder\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"},{\"kind\":2048,\"name\":\"metadata\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#metadata\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"},{\"kind\":2048,\"name\":\"listen\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#listen\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"},{\"kind\":2048,\"name\":\"label\",\"url\":\"classes/NgrokLabeledTunnelBuilder.html#label\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NgrokLabeledTunnelBuilder\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,43.652]],[\"comment/0\",[]],[\"name/1\",[1,43.652]],[\"comment/1\",[]],[\"name/2\",[2,30.659]],[\"comment/2\",[]],[\"name/3\",[3,43.652]],[\"comment/3\",[]],[\"name/4\",[4,43.652]],[\"comment/4\",[]],[\"name/5\",[5,23.283]],[\"comment/5\",[]],[\"name/6\",[6,43.652]],[\"comment/6\",[]],[\"name/7\",[7,43.652]],[\"comment/7\",[]],[\"name/8\",[8,43.652]],[\"comment/8\",[]],[\"name/9\",[9,43.652]],[\"comment/9\",[]],[\"name/10\",[10,25.194]],[\"comment/10\",[]],[\"name/11\",[11,43.652]],[\"comment/11\",[]],[\"name/12\",[12,43.652]],[\"comment/12\",[]],[\"name/13\",[13,43.652]],[\"comment/13\",[]],[\"name/14\",[14,43.652]],[\"comment/14\",[]],[\"name/15\",[15,43.652]],[\"comment/15\",[]],[\"name/16\",[16,43.652]],[\"comment/16\",[]],[\"name/17\",[17,43.652]],[\"comment/17\",[]],[\"name/18\",[18,43.652]],[\"comment/18\",[]],[\"name/19\",[19,43.652]],[\"comment/19\",[]],[\"name/20\",[5,23.283]],[\"comment/20\",[]],[\"name/21\",[20,43.652]],[\"comment/21\",[]],[\"name/22\",[21,43.652]],[\"comment/22\",[]],[\"name/23\",[22,43.652]],[\"comment/23\",[]],[\"name/24\",[23,43.652]],[\"comment/24\",[]],[\"name/25\",[24,43.652]],[\"comment/25\",[]],[\"name/26\",[25,30.659]],[\"comment/26\",[]],[\"name/27\",[26,43.652]],[\"comment/27\",[]],[\"name/28\",[5,23.283]],[\"comment/28\",[]],[\"name/29\",[27,43.652]],[\"comment/29\",[]],[\"name/30\",[28,43.652]],[\"comment/30\",[]],[\"name/31\",[29,43.652]],[\"comment/31\",[]],[\"name/32\",[5,23.283]],[\"comment/32\",[]],[\"name/33\",[30,35.179]],[\"comment/33\",[]],[\"name/34\",[31,35.179]],[\"comment/34\",[]],[\"name/35\",[32,32.666]],[\"comment/35\",[]],[\"name/36\",[33,27.558]],[\"comment/36\",[]],[\"name/37\",[10,25.194]],[\"comment/37\",[]],[\"name/38\",[34,32.666]],[\"comment/38\",[]],[\"name/39\",[35,32.666]],[\"comment/39\",[]],[\"name/40\",[25,30.659]],[\"comment/40\",[]],[\"name/41\",[36,43.652]],[\"comment/41\",[]],[\"name/42\",[5,23.283]],[\"comment/42\",[]],[\"name/43\",[30,35.179]],[\"comment/43\",[]],[\"name/44\",[31,35.179]],[\"comment/44\",[]],[\"name/45\",[32,32.666]],[\"comment/45\",[]],[\"name/46\",[33,27.558]],[\"comment/46\",[]],[\"name/47\",[10,25.194]],[\"comment/47\",[]],[\"name/48\",[34,32.666]],[\"comment/48\",[]],[\"name/49\",[35,32.666]],[\"comment/49\",[]],[\"name/50\",[25,30.659]],[\"comment/50\",[]],[\"name/51\",[37,43.652]],[\"comment/51\",[]],[\"name/52\",[5,23.283]],[\"comment/52\",[]],[\"name/53\",[30,35.179]],[\"comment/53\",[]],[\"name/54\",[31,35.179]],[\"comment/54\",[]],[\"name/55\",[32,32.666]],[\"comment/55\",[]],[\"name/56\",[33,27.558]],[\"comment/56\",[]],[\"name/57\",[10,25.194]],[\"comment/57\",[]],[\"name/58\",[34,32.666]],[\"comment/58\",[]],[\"name/59\",[35,32.666]],[\"comment/59\",[]],[\"name/60\",[25,30.659]],[\"comment/60\",[]],[\"name/61\",[38,43.652]],[\"comment/61\",[]],[\"name/62\",[5,23.283]],[\"comment/62\",[]],[\"name/63\",[39,43.652]],[\"comment/63\",[]],[\"name/64\",[32,32.666]],[\"comment/64\",[]],[\"name/65\",[33,27.558]],[\"comment/65\",[]],[\"name/66\",[10,25.194]],[\"comment/66\",[]],[\"name/67\",[34,32.666]],[\"comment/67\",[]],[\"name/68\",[35,32.666]],[\"comment/68\",[]],[\"name/69\",[25,30.659]],[\"comment/69\",[]],[\"name/70\",[40,43.652]],[\"comment/70\",[]],[\"name/71\",[5,23.283]],[\"comment/71\",[]],[\"name/72\",[41,43.652]],[\"comment/72\",[]],[\"name/73\",[42,38.544]],[\"comment/73\",[]],[\"name/74\",[43,38.544]],[\"comment/74\",[]],[\"name/75\",[44,43.652]],[\"comment/75\",[]],[\"name/76\",[45,43.652]],[\"comment/76\",[]],[\"name/77\",[46,43.652]],[\"comment/77\",[]],[\"name/78\",[47,43.652]],[\"comment/78\",[]],[\"name/79\",[48,43.652]],[\"comment/79\",[]],[\"name/80\",[49,43.652]],[\"comment/80\",[]],[\"name/81\",[50,43.652]],[\"comment/81\",[]],[\"name/82\",[51,43.652]],[\"comment/82\",[]],[\"name/83\",[52,43.652]],[\"comment/83\",[]],[\"name/84\",[53,43.652]],[\"comment/84\",[]],[\"name/85\",[54,43.652]],[\"comment/85\",[]],[\"name/86\",[10,25.194]],[\"comment/86\",[]],[\"name/87\",[2,30.659]],[\"comment/87\",[]],[\"name/88\",[55,35.179]],[\"comment/88\",[]],[\"name/89\",[56,35.179]],[\"comment/89\",[]],[\"name/90\",[57,35.179]],[\"comment/90\",[]],[\"name/91\",[33,27.558]],[\"comment/91\",[]],[\"name/92\",[58,43.652]],[\"comment/92\",[]],[\"name/93\",[5,23.283]],[\"comment/93\",[]],[\"name/94\",[59,43.652]],[\"comment/94\",[]],[\"name/95\",[10,25.194]],[\"comment/95\",[]],[\"name/96\",[2,30.659]],[\"comment/96\",[]],[\"name/97\",[55,35.179]],[\"comment/97\",[]],[\"name/98\",[56,35.179]],[\"comment/98\",[]],[\"name/99\",[57,35.179]],[\"comment/99\",[]],[\"name/100\",[33,27.558]],[\"comment/100\",[]],[\"name/101\",[60,43.652]],[\"comment/101\",[]],[\"name/102\",[5,23.283]],[\"comment/102\",[]],[\"name/103\",[42,38.544]],[\"comment/103\",[]],[\"name/104\",[43,38.544]],[\"comment/104\",[]],[\"name/105\",[61,43.652]],[\"comment/105\",[]],[\"name/106\",[10,25.194]],[\"comment/106\",[]],[\"name/107\",[2,30.659]],[\"comment/107\",[]],[\"name/108\",[55,35.179]],[\"comment/108\",[]],[\"name/109\",[56,35.179]],[\"comment/109\",[]],[\"name/110\",[57,35.179]],[\"comment/110\",[]],[\"name/111\",[33,27.558]],[\"comment/111\",[]],[\"name/112\",[62,43.652]],[\"comment/112\",[]],[\"name/113\",[5,23.283]],[\"comment/113\",[]],[\"name/114\",[10,25.194]],[\"comment/114\",[]],[\"name/115\",[2,30.659]],[\"comment/115\",[]],[\"name/116\",[63,43.652]],[\"comment/116\",[]]],\"invertedIndex\":[[\"allowcidr\",{\"_index\":55,\"name\":{\"88\":{},\"97\":{},\"108\":{}},\"comment\":{}}],[\"authtoken\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"authtokenfromenv\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"basicauth\",{\"_index\":51,\"name\":{\"82\":{}},\"comment\":{}}],[\"cacert\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"circuitbreaker\",{\"_index\":46,\"name\":{\"77\":{}},\"comment\":{}}],[\"close\",{\"_index\":25,\"name\":{\"26\":{},\"40\":{},\"50\":{},\"60\":{},\"69\":{}},\"comment\":{}}],[\"closetunnel\",{\"_index\":24,\"name\":{\"25\":{}},\"comment\":{}}],[\"compression\",{\"_index\":44,\"name\":{\"75\":{}},\"comment\":{}}],[\"connect\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"consolelog\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":5,\"name\":{\"5\":{},\"20\":{},\"28\":{},\"32\":{},\"42\":{},\"52\":{},\"62\":{},\"71\":{},\"93\":{},\"102\":{},\"113\":{}},\"comment\":{}}],[\"denycidr\",{\"_index\":56,\"name\":{\"89\":{},\"98\":{},\"109\":{}},\"comment\":{}}],[\"domain\",{\"_index\":42,\"name\":{\"73\":{},\"103\":{}},\"comment\":{}}],[\"forwardpipe\",{\"_index\":35,\"name\":{\"39\":{},\"49\":{},\"59\":{},\"68\":{}},\"comment\":{}}],[\"forwardsto\",{\"_index\":33,\"name\":{\"36\":{},\"46\":{},\"56\":{},\"65\":{},\"91\":{},\"100\":{},\"111\":{}},\"comment\":{}}],[\"forwardtcp\",{\"_index\":34,\"name\":{\"38\":{},\"48\":{},\"58\":{},\"67\":{}},\"comment\":{}}],[\"handledisconnection\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"handleheartbeat\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"handlerestartcommand\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"handlestopcommand\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"handleupdatecommand\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"heartbeatinterval\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"heartbeattolerance\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"httpendpoint\",{\"_index\":20,\"name\":{\"21\":{}},\"comment\":{}}],[\"id\",{\"_index\":32,\"name\":{\"35\":{},\"45\":{},\"55\":{},\"64\":{}},\"comment\":{}}],[\"label\",{\"_index\":63,\"name\":{\"116\":{}},\"comment\":{}}],[\"labeledtunnel\",{\"_index\":23,\"name\":{\"24\":{}},\"comment\":{}}],[\"labels\",{\"_index\":39,\"name\":{\"63\":{}},\"comment\":{}}],[\"listen\",{\"_index\":2,\"name\":{\"2\":{},\"87\":{},\"96\":{},\"107\":{},\"115\":{}},\"comment\":{}}],[\"listenable\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"loggingcallback\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"metadata\",{\"_index\":10,\"name\":{\"10\":{},\"37\":{},\"47\":{},\"57\":{},\"66\":{},\"86\":{},\"95\":{},\"106\":{},\"114\":{}},\"comment\":{}}],[\"mutualtlsca\",{\"_index\":43,\"name\":{\"74\":{},\"104\":{}},\"comment\":{}}],[\"ngrokhttptunnel\",{\"_index\":29,\"name\":{\"31\":{}},\"comment\":{}}],[\"ngrokhttptunnelbuilder\",{\"_index\":40,\"name\":{\"70\":{}},\"comment\":{}}],[\"ngroklabeledtunnel\",{\"_index\":38,\"name\":{\"61\":{}},\"comment\":{}}],[\"ngroklabeledtunnelbuilder\",{\"_index\":62,\"name\":{\"112\":{}},\"comment\":{}}],[\"ngroksession\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"ngroksessionbuilder\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"ngroktcptunnel\",{\"_index\":36,\"name\":{\"41\":{}},\"comment\":{}}],[\"ngroktcptunnelbuilder\",{\"_index\":58,\"name\":{\"92\":{}},\"comment\":{}}],[\"ngroktlstunnel\",{\"_index\":37,\"name\":{\"51\":{}},\"comment\":{}}],[\"ngroktlstunnelbuilder\",{\"_index\":60,\"name\":{\"101\":{}},\"comment\":{}}],[\"oauth\",{\"_index\":52,\"name\":{\"83\":{}},\"comment\":{}}],[\"oidc\",{\"_index\":53,\"name\":{\"84\":{}},\"comment\":{}}],[\"permitmajorversion\",{\"_index\":28,\"name\":{\"30\":{}},\"comment\":{}}],[\"proto\",{\"_index\":31,\"name\":{\"34\":{},\"44\":{},\"54\":{}},\"comment\":{}}],[\"proxyproto\",{\"_index\":57,\"name\":{\"90\":{},\"99\":{},\"110\":{}},\"comment\":{}}],[\"remoteaddr\",{\"_index\":59,\"name\":{\"94\":{}},\"comment\":{}}],[\"removerequestheader\",{\"_index\":49,\"name\":{\"80\":{}},\"comment\":{}}],[\"removeresponseheader\",{\"_index\":50,\"name\":{\"81\":{}},\"comment\":{}}],[\"requestheader\",{\"_index\":47,\"name\":{\"78\":{}},\"comment\":{}}],[\"responseheader\",{\"_index\":48,\"name\":{\"79\":{}},\"comment\":{}}],[\"scheme\",{\"_index\":41,\"name\":{\"72\":{}},\"comment\":{}}],[\"serveraddr\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"tcpendpoint\",{\"_index\":21,\"name\":{\"22\":{}},\"comment\":{}}],[\"termination\",{\"_index\":61,\"name\":{\"105\":{}},\"comment\":{}}],[\"tlsendpoint\",{\"_index\":22,\"name\":{\"23\":{}},\"comment\":{}}],[\"updaterequest\",{\"_index\":26,\"name\":{\"27\":{}},\"comment\":{}}],[\"url\",{\"_index\":30,\"name\":{\"33\":{},\"43\":{},\"53\":{}},\"comment\":{}}],[\"version\",{\"_index\":27,\"name\":{\"29\":{}},\"comment\":{}}],[\"webhookverification\",{\"_index\":54,\"name\":{\"85\":{}},\"comment\":{}}],[\"websockettcpconversion\",{\"_index\":45,\"name\":{\"76\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/classes/NgrokHttpTunnel.html b/docs/classes/NgrokHttpTunnel.html index dba6a92..f8c0133 100644 --- a/docs/classes/NgrokHttpTunnel.html +++ b/docs/classes/NgrokHttpTunnel.html @@ -23,7 +23,7 @@

Hierarchy

  • NgrokHttpTunnel
+
  • Defined in index.d.ts:168
    • @@ -66,7 +66,7 @@

    closeReturns Promise<void>

    +
  • Defined in index.d.ts:199

    • forwardPipe

      @@ -83,7 +83,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:191

    • forwardTcp

      @@ -98,7 +98,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:185

    • forwardsTo

    +
  • Defined in index.d.ts:181

    • id

    +
  • Defined in index.d.ts:174

    • metadata

    +
  • Defined in index.d.ts:183

    • proto

    +
  • Defined in index.d.ts:172

    • url

    +
  • Defined in index.d.ts:170
    • diff --git a/docs/classes/NgrokHttpTunnelBuilder.html b/docs/classes/NgrokHttpTunnelBuilder.html index 6219f44..568cf1a 100644 --- a/docs/classes/NgrokHttpTunnelBuilder.html +++ b/docs/classes/NgrokHttpTunnelBuilder.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokHttpTunnelBuilder
    +
  • Defined in index.d.ts:302
    • @@ -81,7 +81,7 @@

    Parameters

    cidr: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:357

    • basicAuth

      @@ -99,7 +99,7 @@
      username: string
      password: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:333

    • circuitBreaker

      @@ -115,7 +115,7 @@

      Parameters

      circuitBreaker: number

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:320

    • compression

    +
  • Defined in index.d.ts:313

    • denyCidr

      @@ -141,7 +141,7 @@

      Parameters

      cidr: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:362

    • domain

      @@ -156,7 +156,7 @@

      Parameters

      domain: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:309

    • forwardsTo

      @@ -172,7 +172,7 @@

      Parameters

      forwardsTo: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:369

    • listen

      @@ -187,7 +187,7 @@

      Parameters

      Optional bind: boolean

    Returns Promise<NgrokHttpTunnel>

    +
  • Defined in index.d.ts:352

    • metadata

      @@ -202,7 +202,7 @@

      Parameters

      metadata: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:350

    • mutualTlsca

      @@ -217,7 +217,7 @@

      Parameters

      mutualTlsca: Uint8Array

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:311

    • oauth

      @@ -239,7 +239,7 @@
      Optional allowDomains: Optional scopes: string[]

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:338

    • oidc

      @@ -265,7 +265,7 @@
      Optional allowDomains: Optional scopes: string[]

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:343

    • proxyProto

      @@ -280,7 +280,7 @@

      Parameters

      proxyProto: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:364

    • removeRequestHeader

      @@ -295,7 +295,7 @@

      Parameters

      name: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:326

    • removeResponseHeader

      @@ -310,7 +310,7 @@

      Parameters

      name: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:328

    • requestHeader

      @@ -327,7 +327,7 @@
      name: string
      value: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:322

    • responseHeader

      @@ -344,7 +344,7 @@
      name: string
      value: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:324

    • scheme

      @@ -360,7 +360,7 @@

      Parameters

      scheme: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:307

    • webhookVerification

      @@ -378,7 +378,7 @@
      provider: string
      secret: string

    Returns NgrokHttpTunnelBuilder

    +
  • Defined in index.d.ts:348

    • websocketTcpConversion

    +
  • Defined in index.d.ts:315
    • diff --git a/docs/classes/NgrokLabeledTunnel.html b/docs/classes/NgrokLabeledTunnel.html index fcdf0e2..ce66a62 100644 --- a/docs/classes/NgrokLabeledTunnel.html +++ b/docs/classes/NgrokLabeledTunnel.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokLabeledTunnel
    +
  • Defined in index.d.ts:270
    • @@ -65,7 +65,7 @@

    closeReturns Promise<void>

    +
  • Defined in index.d.ts:299

    • forwardPipe

      @@ -82,7 +82,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:291

    • forwardTcp

      @@ -97,7 +97,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:285

    • forwardsTo

    +
  • Defined in index.d.ts:281

    • id

    +
  • Defined in index.d.ts:274

    • labels

    +
  • Defined in index.d.ts:272

    • metadata

    +
  • Defined in index.d.ts:283
    • diff --git a/docs/classes/NgrokLabeledTunnelBuilder.html b/docs/classes/NgrokLabeledTunnelBuilder.html index 3d53257..b2e37db 100644 --- a/docs/classes/NgrokLabeledTunnelBuilder.html +++ b/docs/classes/NgrokLabeledTunnelBuilder.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokLabeledTunnelBuilder
    +
  • Defined in index.d.ts:428
    • @@ -65,7 +65,7 @@
    label: string
    value: string

    Returns NgrokLabeledTunnelBuilder

    +
  • Defined in index.d.ts:434

    • listen

      @@ -80,7 +80,7 @@

      Parameters

      Optional bind: boolean

    Returns Promise<NgrokLabeledTunnel>

    +
  • Defined in index.d.ts:432

    • metadata

      @@ -95,7 +95,7 @@

      Parameters

      metadata: string

    Returns NgrokLabeledTunnelBuilder

    +
  • Defined in index.d.ts:430
    • diff --git a/docs/classes/NgrokSession.html b/docs/classes/NgrokSession.html index dd33c63..c5f2484 100644 --- a/docs/classes/NgrokSession.html +++ b/docs/classes/NgrokSession.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokSession
    +
  • Defined in index.d.ts:147
    • @@ -35,7 +35,8 @@

    Constructors

    Methods

    -
    closeTunnel +
    close +closeTunnel httpEndpoint labeledTunnel tcpEndpoint @@ -51,6 +52,16 @@

    constructorReturns NgrokSession

    Methods

    +
    +

    close

    +
      + +
    • +

      Close the ngrok session.

      +
      +

      Returns Promise<void>

    closeTunnel

      @@ -65,7 +76,7 @@

      Parameters

      id: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:157

    • httpEndpoint

    +
  • Defined in index.d.ts:149

    • labeledTunnel

    +
  • Defined in index.d.ts:155

    • tcpEndpoint

    +
  • Defined in index.d.ts:151

    • tlsEndpoint

    +
  • Defined in index.d.ts:153
    • @@ -132,6 +143,7 @@

    NgrokSession
    @@ -37,7 +37,10 @@

    Constructors

    Methods

    authtoken authtokenFromEnv +caCert connect +handleDisconnection +handleHeartbeat handleRestartCommand handleStopCommand handleUpdateCommand @@ -57,7 +60,7 @@

    constructor

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:15

    • Methods

    @@ -77,7 +80,7 @@

    Parameters

    authtoken: string

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:27

    • authtokenFromEnv

    +
  • Defined in index.d.ts:32
    • +
    +

    caCert

    +
      + +
    • +

      Configures the TLS certificate used to connect to the ngrok service while +establishing the session. Use this option only if you are connecting through +a man-in-the-middle or deep packet inspection proxy. Pass in the bytes of the certificate +to be used to validate the connection, then override the address to connect to via +the server_addr call.

      +

      Roughly corresponds to the root_cas parameter in the ngrok docs.

      +
      +
      +

      Parameters

      +
        +
      • +
        certBytes: Uint8Array
      +

      Returns NgrokSessionBuilder

    connect

    +
  • Defined in index.d.ts:144
    • +
    +

    handleDisconnection

    +
      + +
    • +

      Configures a function which is called to after a disconnection to the +ngrok service. In the event of network disruptions, it will be called each time +the session reconnects. The handler is given the address that will be used to +connect the session to, e.g. "example.com:443", and the message from the error +that occurred. Returning true from the handler will cause the session to +reconnect, returning false will cause the Session to throw an uncaught error.

      +
      +
      +

      Parameters

      +
        +
      • +
        handler: ((addr: string, error: string) => boolean)
        +
          +
        • +
            +
          • (addr: string, error: string): boolean
            • +
          • +
            +

            Parameters

            +
              +
            • +
              addr: string
              • +
            • +
              error: string
            +

            Returns boolean

      +

      Returns NgrokSessionBuilder

    +
    +

    handleHeartbeat

    +
      + +
    • +

      Call the provided handler whenever a heartbeat response is received, +with the latency in milliseconds.

      +

      If the handler returns an error, the heartbeat task will exit, resulting +in the session eventually dying as well.

      +
      +
      +

      Parameters

      +
        +
      • +
        handler: ((latency: number) => void)
        +
          +
        • +
            +
          • (latency: number): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              latency: number
            +

            Returns void

      +

      Returns NgrokSessionBuilder

    handleRestartCommand

      @@ -127,7 +212,7 @@
      handler: (Returns void

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:120

    • handleStopCommand

      @@ -155,7 +240,7 @@
      handler: (Returns void

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:106

    • handleUpdateCommand

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:134

    • heartbeatInterval

      @@ -207,7 +292,7 @@

      Parameters

      heartbeatInterval: number

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:42

    • heartbeatTolerance

      @@ -225,7 +310,7 @@

      Parameters

      heartbeatTolerance: number

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:52

    • metadata

      @@ -244,7 +329,7 @@

      Parameters

      metadata: string

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:63

    • serverAddr

      @@ -261,7 +346,7 @@

      Parameters

      addr: string

    Returns NgrokSessionBuilder

    +
  • Defined in index.d.ts:72
    • @@ -290,7 +375,10 @@

    constructor
  • authtoken
  • authtokenFromEnv
    • +
  • caCert
  • connect
    • +
  • handleDisconnection
    • +
  • handleHeartbeat
  • handleRestartCommand
  • handleStopCommand
  • handleUpdateCommand
    • diff --git a/docs/classes/NgrokTcpTunnel.html b/docs/classes/NgrokTcpTunnel.html index d76f328..88975f8 100644 --- a/docs/classes/NgrokTcpTunnel.html +++ b/docs/classes/NgrokTcpTunnel.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokTcpTunnel
    +
  • Defined in index.d.ts:202
    • @@ -66,7 +66,7 @@

    closeReturns Promise<void>

    +
  • Defined in index.d.ts:233

    • forwardPipe

      @@ -83,7 +83,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:225

    • forwardTcp

      @@ -98,7 +98,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:219

    • forwardsTo

    +
  • Defined in index.d.ts:215

    • id

    +
  • Defined in index.d.ts:208

    • metadata

    +
  • Defined in index.d.ts:217

    • proto

    +
  • Defined in index.d.ts:206

    • url

    +
  • Defined in index.d.ts:204
    • diff --git a/docs/classes/NgrokTcpTunnelBuilder.html b/docs/classes/NgrokTcpTunnelBuilder.html index 07642fa..caa53d0 100644 --- a/docs/classes/NgrokTcpTunnelBuilder.html +++ b/docs/classes/NgrokTcpTunnelBuilder.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokTcpTunnelBuilder
    +
  • Defined in index.d.ts:372
    • @@ -68,7 +68,7 @@

    Parameters

    cidr: string

    Returns NgrokTcpTunnelBuilder

    +
  • Defined in index.d.ts:383

    • denyCidr

      @@ -84,7 +84,7 @@

      Parameters

      cidr: string

    Returns NgrokTcpTunnelBuilder

    +
  • Defined in index.d.ts:388

    • forwardsTo

      @@ -100,7 +100,7 @@

      Parameters

      forwardsTo: string

    Returns NgrokTcpTunnelBuilder

    +
  • Defined in index.d.ts:395

    • listen

      @@ -115,7 +115,7 @@

      Parameters

      Optional bind: boolean

    Returns Promise<NgrokTcpTunnel>

    +
  • Defined in index.d.ts:378

    • metadata

      @@ -130,7 +130,7 @@

      Parameters

      metadata: string

    Returns NgrokTcpTunnelBuilder

    +
  • Defined in index.d.ts:376

    • proxyProto

      @@ -145,7 +145,7 @@

      Parameters

      proxyProto: string

    Returns NgrokTcpTunnelBuilder

    +
  • Defined in index.d.ts:390

    • remoteAddr

      @@ -160,7 +160,7 @@

      Parameters

      remoteAddr: string

    Returns NgrokTcpTunnelBuilder

    +
  • Defined in index.d.ts:374
    • diff --git a/docs/classes/NgrokTlsTunnel.html b/docs/classes/NgrokTlsTunnel.html index 2afc758..3ea3809 100644 --- a/docs/classes/NgrokTlsTunnel.html +++ b/docs/classes/NgrokTlsTunnel.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokTlsTunnel
    +
  • Defined in index.d.ts:236
    • @@ -66,7 +66,7 @@

    closeReturns Promise<void>

    +
  • Defined in index.d.ts:267

    • forwardPipe

      @@ -83,7 +83,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:259

    • forwardTcp

      @@ -98,7 +98,7 @@

      Parameters

      addr: string

    Returns Promise<void>

    +
  • Defined in index.d.ts:253

    • forwardsTo

    +
  • Defined in index.d.ts:249

    • id

    +
  • Defined in index.d.ts:242

    • metadata

    +
  • Defined in index.d.ts:251

    • proto

    +
  • Defined in index.d.ts:240

    • url

    +
  • Defined in index.d.ts:238
    • diff --git a/docs/classes/NgrokTlsTunnelBuilder.html b/docs/classes/NgrokTlsTunnelBuilder.html index 07e750e..08340c3 100644 --- a/docs/classes/NgrokTlsTunnelBuilder.html +++ b/docs/classes/NgrokTlsTunnelBuilder.html @@ -23,7 +23,7 @@

    Hierarchy

    • NgrokTlsTunnelBuilder
    +
  • Defined in index.d.ts:398
    • @@ -70,7 +70,7 @@

    Parameters

    cidr: string

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:413

    • denyCidr

      @@ -86,7 +86,7 @@

      Parameters

      cidr: string

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:418

    • domain

      @@ -101,7 +101,7 @@

      Parameters

      domain: string

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:400

    • forwardsTo

      @@ -117,7 +117,7 @@

      Parameters

      forwardsTo: string

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:425

    • listen

      @@ -132,7 +132,7 @@

      Parameters

      Optional bind: boolean

    Returns Promise<NgrokTlsTunnel>

    +
  • Defined in index.d.ts:408

    • metadata

      @@ -147,7 +147,7 @@

      Parameters

      metadata: string

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:406

    • mutualTlsca

      @@ -162,7 +162,7 @@

      Parameters

      mutualTlsca: Uint8Array

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:402

    • proxyProto

      @@ -177,7 +177,7 @@

      Parameters

      proxyProto: string

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:420

    • termination

      @@ -194,7 +194,7 @@
      certPem: Uint8Array
      keyPem: Uint8Array

    Returns NgrokTlsTunnelBuilder

    +
  • Defined in index.d.ts:404
    • diff --git a/docs/classes/UpdateRequest.html b/docs/classes/UpdateRequest.html index 3503889..627854e 100644 --- a/docs/classes/UpdateRequest.html +++ b/docs/classes/UpdateRequest.html @@ -20,7 +20,7 @@

    Hierarchy

    • UpdateRequest
    +
  • Defined in index.d.ts:161
    • @@ -51,14 +51,14 @@

    permitMajorVersion

    Whether or not updating to the same major version is sufficient.

    +
  • Defined in index.d.ts:165

    • version

    version: string

    The version that the agent is requested to update to.

    +
  • Defined in index.d.ts:163
    • diff --git a/docs/functions/consoleLog.html b/docs/functions/consoleLog.html index 94d2fc6..891a4a8 100644 --- a/docs/functions/consoleLog.html +++ b/docs/functions/consoleLog.html @@ -29,7 +29,7 @@

    Parameters

    Optional level: String

    Returns any

    +
  • Defined in index.d.ts:444
    • diff --git a/docs/functions/listen.html b/docs/functions/listen.html index ad1168d..5adfa6f 100644 --- a/docs/functions/listen.html +++ b/docs/functions/listen.html @@ -30,7 +30,7 @@
    server: Server
    Optional tunnel: NgrokHttpTunnel | NgrokTcpTunnel | NgrokTlsTunnel | NgrokLabeledTunnel

    Returns NgrokHttpTunnel | NgrokTcpTunnel | NgrokTlsTunnel | NgrokLabeledTunnel

    +
  • Defined in index.d.ts:439
    • diff --git a/docs/functions/listenable.html b/docs/functions/listenable.html index 2f27c0f..3b9c3a8 100644 --- a/docs/functions/listenable.html +++ b/docs/functions/listenable.html @@ -28,7 +28,7 @@

    Parameters

    Optional tunnel: NgrokHttpTunnel | NgrokTcpTunnel | NgrokTlsTunnel | NgrokLabeledTunnel

    Returns NgrokHttpTunnel | NgrokTcpTunnel | NgrokTlsTunnel | NgrokLabeledTunnel

    +
  • Defined in index.d.ts:437
    • diff --git a/docs/functions/loggingCallback.html b/docs/functions/loggingCallback.html index fd14699..93ca776 100644 --- a/docs/functions/loggingCallback.html +++ b/docs/functions/loggingCallback.html @@ -47,7 +47,7 @@

    Returns voidOptional level: string

    Returns void

    +
  • Defined in index.d.ts:11
    • diff --git a/docs/index.html b/docs/index.html index e52809d..7002141 100644 --- a/docs/index.html +++ b/docs/index.html @@ -20,9 +20,8 @@

    The ngrok Agent SDK for NodeJS

    MIT licensed Apache-2.0 licensed Continuous integration

    -

    Website

    Note: This is alpha-quality software. Interfaces are subject to change without warning.

    -

    ngrok is a globally distributed reverse proxy commonly used for quickly getting a public URL to a +

    ngrok 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 deployed inside a private network and is used to communicate with the ngrok cloud service.

    This is the ngrok agent in library form, suitable for integrating directly into NodeJS diff --git a/npm/android-arm-eabi/package.json b/npm/android-arm-eabi/package.json index dddf0fa..fd0fbc8 100644 --- a/npm/android-arm-eabi/package.json +++ b/npm/android-arm-eabi/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-android-arm-eabi", - "version": "0.0.12", + "version": "0.1.0", "os": [ "android" ], diff --git a/npm/android-arm64/package.json b/npm/android-arm64/package.json index ff4468c..2c3f83b 100644 --- a/npm/android-arm64/package.json +++ b/npm/android-arm64/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-android-arm64", - "version": "0.0.12", + "version": "0.1.0", "os": [ "android" ], diff --git a/npm/darwin-arm64/package.json b/npm/darwin-arm64/package.json index 860b9c9..aa6a798 100644 --- a/npm/darwin-arm64/package.json +++ b/npm/darwin-arm64/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-darwin-arm64", - "version": "0.0.12", + "version": "0.1.0", "os": [ "darwin" ], diff --git a/npm/darwin-universal/package.json b/npm/darwin-universal/package.json index eabf0a2..54fcd9f 100644 --- a/npm/darwin-universal/package.json +++ b/npm/darwin-universal/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-darwin-universal", - "version": "0.0.12", + "version": "0.1.0", "os": [ "darwin" ], diff --git a/npm/darwin-x64/package.json b/npm/darwin-x64/package.json index 150e3e7..7c98cf7 100644 --- a/npm/darwin-x64/package.json +++ b/npm/darwin-x64/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-darwin-x64", - "version": "0.0.12", + "version": "0.1.0", "os": [ "darwin" ], diff --git a/npm/freebsd-x64/package.json b/npm/freebsd-x64/package.json index 241fb2f..273158c 100644 --- a/npm/freebsd-x64/package.json +++ b/npm/freebsd-x64/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-freebsd-x64", - "version": "0.0.12", + "version": "0.1.0", "os": [ "freebsd" ], diff --git a/npm/linux-arm-gnueabihf/package.json b/npm/linux-arm-gnueabihf/package.json index 90863ff..ca51daf 100644 --- a/npm/linux-arm-gnueabihf/package.json +++ b/npm/linux-arm-gnueabihf/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-linux-arm-gnueabihf", - "version": "0.0.12", + "version": "0.1.0", "os": [ "linux" ], diff --git a/npm/linux-arm64-gnu/package.json b/npm/linux-arm64-gnu/package.json index 0863c06..a838ed6 100644 --- a/npm/linux-arm64-gnu/package.json +++ b/npm/linux-arm64-gnu/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-linux-arm64-gnu", - "version": "0.0.12", + "version": "0.1.0", "os": [ "linux" ], diff --git a/npm/linux-arm64-musl/package.json b/npm/linux-arm64-musl/package.json index 43c27f8..c292838 100644 --- a/npm/linux-arm64-musl/package.json +++ b/npm/linux-arm64-musl/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-linux-arm64-musl", - "version": "0.0.12", + "version": "0.1.0", "os": [ "linux" ], diff --git a/npm/linux-x64-gnu/package.json b/npm/linux-x64-gnu/package.json index 6696718..3b927e4 100644 --- a/npm/linux-x64-gnu/package.json +++ b/npm/linux-x64-gnu/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-linux-x64-gnu", - "version": "0.0.12", + "version": "0.1.0", "os": [ "linux" ], diff --git a/npm/linux-x64-musl/package.json b/npm/linux-x64-musl/package.json index 82265a0..270fabb 100644 --- a/npm/linux-x64-musl/package.json +++ b/npm/linux-x64-musl/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-linux-x64-musl", - "version": "0.0.12", + "version": "0.1.0", "os": [ "linux" ], diff --git a/npm/win32-arm64-msvc/package.json b/npm/win32-arm64-msvc/package.json index 1977c39..acda7ca 100644 --- a/npm/win32-arm64-msvc/package.json +++ b/npm/win32-arm64-msvc/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-win32-arm64-msvc", - "version": "0.0.12", + "version": "0.1.0", "os": [ "win32" ], diff --git a/npm/win32-ia32-msvc/package.json b/npm/win32-ia32-msvc/package.json index 16a27a6..9cdca4c 100644 --- a/npm/win32-ia32-msvc/package.json +++ b/npm/win32-ia32-msvc/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-win32-ia32-msvc", - "version": "0.0.12", + "version": "0.1.0", "os": [ "win32" ], diff --git a/npm/win32-x64-msvc/package.json b/npm/win32-x64-msvc/package.json index 0a08fa5..fb62d6d 100644 --- a/npm/win32-x64-msvc/package.json +++ b/npm/win32-x64-msvc/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok-win32-x64-msvc", - "version": "0.0.12", + "version": "0.1.0", "os": [ "win32" ], diff --git a/package.json b/package.json index c837309..0aeb95d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ngrok/ngrok", - "version": "0.0.12", + "version": "0.1.0", "main": "index.js", "types": "index.d.ts", "napi": {