Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[4.0.1] - 2020-04-05

Fixed

Trying to connect a new tunnel using a name would drop options like binPath as they were overwritten from the loaded config. #220 changes the behaviour to merge passed options with the named tunnel options
Avoids showing a terminal window on Windows when spawning (#211)

[4.0.0] - 2020-03-27

Breaking changes

Replaced the deprecated request and request-promise-native with got
ngrok.getApi() will now return an NgrokClient object which has methods to call on the available ngrok API methods
Revamped the exported types, there is now an Ngrok namespace under which most types now sit
Added types for the NgrokClient responses

Changed

Changed CI from Travis to GitHub Actions
Brought development dependencies up to date

Fixed

Passing a name option to connect now causes the module to read the ngrok config and retrieve a named tunnel (fixes #197)

[4.0.0-beta.4] - 2020-03-18

Fixed

Really fixed the location of the downloaded binary

[4.0.0-beta.3] - 2020-01-17

Fixed

Moved the download.js file back to the top level, since it can be required individually.

[4.0.0-beta.2] - 2020-01-17

Fixed

Corrected the file listing in package.json

[4.0.0-beta.1] - 2020-01-17

Changed

Replaced the deprecated request and request-promise-native with got
ngrok.getApi() will now return an NgrokClient object which has methods to call on the available ngrok API methods
Revamped the exported types, there is now an Ngrok namespace under which most types now sit
Added types for the NgrokClient responses
Changed CI from Travis to GitHub Actions

Fixed

Passing a name option to connect now causes the module to read the ngrok config and retrieve a named tunnel (fixes #197)

[3.4.0] - 2020-12-22

Please see commit logs for updates prior to version 4.