@types/tunnel-ssh

Installation

npm install --save @types/tunnel-ssh

Summary

This package contains type definitions for tunnel-ssh (https://github.com/agebrock/tunnel-ssh).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tunnel-ssh.

index.d.ts

// Type definitions for tunnel-ssh 5.0
// Project: https://github.com/agebrock/tunnel-ssh
// Definitions by: DefinitelyTyped <https://github.com/DefinitelyTyped>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import * as net from "net";
import * as ssh2 from "ssh2";

export interface TunnelOptions {
    autoClose?: boolean;
}
export interface ForwardOptions {
    srcAddr: string;
    srcPort: number;
    dstAddr: string;
    dstPort: number;
}

export function createTunnel(
    tunnelOptions: TunnelOptions,
    serverOptions: net.ListenOptions,
    sshOptions: ssh2.ConnectConfig,
    forwardOptions: ForwardOptions,
): Promise<[net.Server, ssh2.Client]>;

Additional Details

• Last updated: Tue, 12 Sep 2023 12:34:53 GMT
• Dependencies: @types/ssh2
• Global values: none

Credits

These definitions were written by DefinitelyTyped.