Class ScpNextClientImpl

Implements

ScpNextClient

Index

Constructors

Methods

close connect download exec upload

Constructors

constructor

new ScpNextClientImpl(
serverOptions: ScpServerOptions,
dependencies?: ScpNextClientDependencies,
): ScpNextClientImpl
Parameters
- serverOptions: ScpServerOptions
- dependencies: ScpNextClientDependencies = {}
Returns ScpNextClientImpl
- Defined in src/client/client.ts:96

Methods

close

close(): Promise<void>
Returns Promise<void>
Implementation of ScpNextClient.close
- Defined in src/client/client.ts:205

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of ScpNextClient.connect
- Defined in src/client/client.ts:102

download

download(
    remotePath: string,
    localPath: string,
    options?: TransferOptions,
): Promise<void>
Parameters
- remotePath: string
- localPath: string
- options: TransferOptions = {}
Returns Promise<void>
Implementation of ScpNextClient.download
- Defined in src/client/client.ts:133

exec

exec(command: string, options?: ExecOptions): Promise<ExecResult>
Parameters
- command: string
- options: ExecOptions = {}
Returns Promise<ExecResult>
Implementation of ScpNextClient.exec
- Defined in src/client/client.ts:153

upload

upload(
    localPath: string,
    remotePath: string,
    options?: TransferOptions,
): Promise<ExecResult[]>
Parameters
- localPath: string
- remotePath: string
- options: TransferOptions = {}
Returns Promise<ExecResult[]>
Implementation of ScpNextClient.upload
- Defined in src/client/client.ts:108