Class RemoteSSHConnection

constructor

• new RemoteSSHConnection(
      options: RemoteSSHConnectionOptions,
  ): RemoteSSHConnection

  Parameters

  • options: RemoteSSHConnectionOptions

  Returns RemoteSSHConnection

client

id

localPort

name

remotePort

type

onDidDisconnect

• get onDidDisconnect(): Event<void>

  Returns Event<void>

copy

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

  copy files from local to remote

  Parameters

  • localPath: string
  • remotePath: string

  Returns Promise<void>

dispose

• dispose(): void

  Dispose this object.

  Returns void

exec

• exec(
      cmd: string,
      args?: string[],
      options?: RemoteExecOptions,
  ): Promise<RemoteExecResult>

  execute a single command on the remote machine

  Parameters

  • cmd: string
  • Optionalargs: string[]
  • options: RemoteExecOptions = {}

  Returns Promise<RemoteExecResult>

execPartial

• execPartial(
      cmd: string,
      tester: RemoteExecTester,
      args?: string[],
      options?: RemoteExecOptions,
  ): 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

  • Optionalargs: string[]
  • options: RemoteExecOptions = {}

  Returns Promise<RemoteExecResult>

forwardOut

• forwardOut(socket: Socket, port?: number): void

  Parameters

  • socket: Socket
  • Optionalport: number

  Returns void