Class RemoteWslConnection

constructor

• new RemoteWslConnection(
      options: RemoteWslConnectionOptions,
  ): RemoteWslConnection

  Parameters

  • options: RemoteWslConnectionOptions

  Returns RemoteWslConnection

distribution

id

name

onDidDisconnect

remotePort

type

localPort

• get localPort(): number

  Returns number

copy

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

  copy files from local to remote

  Parameters

  • localPath: string | Buffer | ReadableStream
  • remotePath: string

  Returns Promise<void>

dispose

• dispose(): void

  Dispose this object.

  Returns void

disposeSync

• disposeSync(): void

  used for disposing when theia is shutting down

  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[]
  • Optionaloptions: 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[]
  • Optionaloptions: RemoteExecOptions

  Returns Promise<RemoteExecResult>

forwardOut

• forwardOut(socket: Socket, port: number): Promise<void>

  Parameters

  • socket: Socket
  • port: number

  Returns Promise<void>