ssh2-promise/lib/BaseSSH2Promise.d.ts

Promise wrapper around SSH2 library

/// <reference types="node" />
import { EventEmitter } from 'events';
import TunnelConfig from './tunnelConfig';
export default abstract class BaseSSH2Promise extends EventEmitter {
    /**
     * Execute a cmd
     * @param cmd
     * @param params
     * @param options
     */
    exec(cmd: string, params?: Array<string>, options?: any): Promise<any>;
    /**
     * Spawn a cmd
     * @param cmd
     * @param params
     * @param options
     */
    spawn(cmd: string, params?: Array<string>, options?: any): Promise<any>;
    /**
     * Get shell socket
     */
    shell(options?: any): Promise<any>;
    /**
    * Get a subsys
    */
    subsys(cmd: string): Promise<any>;
    /**
     * Get a X11 port
     */
    x11(cmd: string): Promise<any>;
    /**
     * Get a Socks Port
     */
    getSocksPort(localPort: number): Promise<number>;
    /**
     * Get existing tunnel by name
     */
    getTunnel(name: string): any;
    /**
   * Add new tunnel if not exist
   */
    addTunnel(tunnelConfig: TunnelConfig): Promise<any>;
    /**
     * Close the tunnel
     */
    closeTunnel(name?: string): Promise<any>;
}