Skip to content

Function: scp() ​

Call Signature ​

ts
function scp(
   src, 
   dest, 
   callback
): void;

Copies between local and remote in the style of scp2. The remote side is written as user:password@host:port:/path or given as an options object with a path.

Parameters ​

ParameterType
srcstring | Scp2Options
deststring | Scp2Options
callbackScp2Callback

Returns ​

void

Call Signature ​

ts
function scp(
   src, 
   dest, 
   client, 
   callback
): void;

Copies between local and remote in the style of scp2. The remote side is written as user:password@host:port:/path or given as an options object with a path.

Parameters ​

ParameterType
srcstring | Scp2Options
deststring | Scp2Options
clientClient
callbackScp2Callback

Returns ​

void

Call Signature ​

ts
function scp(
   src, 
   dest, 
   client?
): Promise<void>;

Copies between local and remote in the style of scp2. The remote side is written as user:password@host:port:/path or given as an options object with a path.

Parameters ​

ParameterType
srcstring | Scp2Options
deststring | Scp2Options
client?Client

Returns ​

Promise<void>

Released under the MIT License.