Class SSHExecutor

SSHExecutor built for the usage with nodejs. Under the hood it uses ssh2

Hierarchy

Executor<SSHConfig>
- SSHExecutor

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new SSHExecutor(config: SSHConfig): SSHExecutor

Inherited from Executor.constructor
- Defined in instance/executor.ts:35
Parameters
- config: SSHConfig
Returns SSHExecutor

Properties

Readonly config

config: SSHConfig

Methods

connect

connect(): Promise<void>

- Defined in executors/SSH.ts:20
Returns Promise<void>

disconnect

disconnect(): void

- Defined in executors/SSH.ts:34
Returns void

execute

execute(command: string): Promise<IExecuteResult>
execute(__namedParameters: IExecute): Promise<IExecuteResult>
execute(command: string | IExecute): Promise<IExecuteResult>

Overrides Executor.execute
- Defined in executors/SSH.ts:38
Parameters
- command: string
Returns Promise<IExecuteResult>
Overrides Executor.execute
- Defined in executors/SSH.ts:40
Parameters
- __namedParameters: IExecute
Returns Promise<IExecuteResult>
Overrides Executor.execute
- Defined in executors/SSH.ts:42
Parameters
- command: string | IExecute
Returns Promise<IExecuteResult>

executeSSH

executeSSH(command: string | IExecute): Promise<IExecuteResult>

- Defined in executors/SSH.ts:48
Parameters
- command: string | IExecute
Returns Promise<IExecuteResult>

executeStream

executeStream(command: string | IExecute): Promise<[EventEmitter, CancelFunction, Promise<IExecuteStreamResult>]>

Overrides Executor.executeStream
- Defined in executors/SSH.ts:102
Parameters
- command: string | IExecute
Returns Promise<[EventEmitter, CancelFunction, Promise<IExecuteStreamResult>]>

executeStreamSSH

executeStreamSSH(command: string | IExecute): Promise<[EventEmitter, CancelFunction, Promise<IExecuteStreamResult>]>

- Defined in executors/SSH.ts:108
Parameters
- command: string | IExecute
Returns Promise<[EventEmitter, CancelFunction, Promise<IExecuteStreamResult>]>

Generated using TypeDoc