Class RemoteSSHConnection

constructor

• new RemoteSSHConnection(options): RemoteSSHConnection

• Parameters

  • options: RemoteSSHConnectionOptions

  Returns RemoteSSHConnection

client

id

localPort

name

remotePort

type

onDidDisconnect

• get onDidDisconnect(): Event<void>

• Returns Event<void>

copy

• copy(localPath, remotePath): Promise<void>

• copy files from local to remote

  Parameters

  • localPath: string
  • remotePath: string

  Returns Promise<void>

dispose

• dispose(): void

• Returns void

exec

• exec(cmd, args?, options?): Promise<RemoteExecResult>

• execute a single command on the remote machine

  Parameters

  • cmd: string
  • Optional args: string[]
  • options: RemoteExecOptions = {}

  Returns Promise<RemoteExecResult>

execPartial

• execPartial(cmd, tester, args?, options?): Promise<RemoteExecResult>

• execute a command on the remote machine and wait for a specific output

  Parameters

  • cmd: string
  • tester: RemoteExecTester

    function which returns true if the output is as expected
  • Optional args: string[]
  • options: RemoteExecOptions = {}

  Returns Promise<RemoteExecResult>

forwardOut

• forwardOut(socket, port?): void

• Parameters

  • socket: Socket
  • Optional port: number

  Returns void