Adds connection.shutdown() function.

Author: Martin Wentzel

README.md

@@ -95,14 +95,17 @@ Starts an interactive shell session. Will resolve when then client has logged ou
 
 #### `connection.forward(forwardOptions: Object)`
 
-Established port-forwarding.
+Established port-forwarding. Promise resolves after the forwarding has been established. Forwarding can be stopped by calling `connection.shutdown()`
 
 Possible options for `forwardOptions`:
 
 * `fromPort` (required): Specifies the port on your local computer
 * `toPort` (required): The port on `endHost` (specified in the SSHConnection options).
 * `toHost` (optional): You can specify an additional `toHost` when you want to forward a port from a different server than your `endHost`.
 
+#### `connection.shutdown()`
+
+Closes all connections.
 
 ## Limitations/Todos
 

src/Connection.ts

@@ -48,7 +48,7 @@ class SSHConnection {
     }
   }
 
-  private async shutdown() {
+  public async shutdown() {
     for (const connection of this.connections) {
       connection.removeAllListeners()
       connection.end()