- Fix
traffic_policy
naming forngrok.forward
- Rename
policy
totraffic_policy
- Fix quickstart example in README
- Add Microsoft Visual C++ Redistributable requirement for Windows to documentation
- Add
rootCas
to session builder androot_cas
tongrok.forward
. Setting this tohost
will use the host's trusted certificates to connect for the ngrok session. - Add
session_ca_cert
andserver_addr
tongrok.forward
, which correspond to the same functions in the session builder.
- Add
verifyUpstreamTls
to listener builders andverify_upstream_tls
tongrok.forward
. Setting this to false will skip verification of the upstream application's TLS certificate.
- Add
appProtocol(string)
to the labeled listener builder. Setting this to "http2" will enable HTTP/2 support to the backend application.
- Add
appProtocol(string)
to http listener builder, andapp_protocol: string
as angrok.forward()
argument. Setting this to "http2" will enable HTTP/2 support to the backend application.
- Add policy support to Listener builders and
ngrok.forward
- Move to
ngrok.forward
fromngrok.connect
, keeping an alias. - Rename to
ngrok-javascript
. - Smaller number of files packaged.
ngrok.connect
now returns the fullListener
object.
- Add
allowUserAgent
anddenyUserAgent
options to HTTP listeners. - Add
clientId
andclientSecret
options to OAuth.
- Fix for windows pipe pathing.
- Add
listen_and_forward
andlisten_and_serve
to listener builders. - Update to latest version of underlying rust library, allowing TLS backends.
- Flattened
listener.forwardPipe()
andlistener.forwardTcp()
intolistener.forward()
. Determination will be made based onaddr
input. - Add
ngrok.listeners()
andsession.listeners()
to get a list of current non-closed listeners for the process or session, respectively. - Add
errorCode
field to thrown errors, where possible. - More heuristics for automatic unix socket file placement.
- Connect heuristic improved for strings parseable as numbers.
- Cleanly return from a listener forward call after a
session.close()
.
consoleLog
return signature.
- Add
Session.clientInfo()
. - Rename to
ngrok-nodejs
.
- Clean shutdown when run from npm.
- Unblock Svelte postinstall script.
- Move to a single listener type for simplicity.
- Documentation updates.
- Added
ngrok.connect(Config)
,ngrok.authtoken()
, andngrok.disconnect(url)
. - Examples cleanup.
- Now have examples for Express, Fastify, Hapi, Koa, Nest.js, Next.js, Remix, Svelte, and Vue.
- Add
prettier
auto code formatting.
- Bump
ngrok-rust
to0.11.3
. - Migrate
ca_cert
to the upstream call inngrok-rust
.
- Added
ca_cert
,handle_heartbeat
, andhandle_disconnection
to Session.
- Added Session.close().
- Cleanly shutdown when listen is called with a pre-configured listener.
- Cleanly shutdown on all platforms when there are callbacks registered.
- Child client versioning support.
- Support for named pipes on Windows.
- Support callbacks for logging, include console.log and Winston handlers.
- Can now pass listeners directly to net.Server.listen().
- Clean shutdown on SIGINT after ngrok.listen(server).
- Typedoc generation of documentation.
- Improved memory management, removing need to keep NodeJS from garbage collecting certain objects.
- Support callbacks for remote operations (stop, restart, update).
- Typescript support for getSocket and listen.
- Initial public release.