Class: ScpClient

The 0.x client returned by Client, with the same methods and events as before.

Deprecated

Use connect from node-scp.

Extends

• EventEmitter

Constructors

Constructor

new ScpClient(options?): ScpClient;

Parameters

Parameter	Type
options	Pick<TScpOptions, "remoteOsType">

Returns

ScpClient

Overrides

EventEmitter.constructor

Properties

Property	Type	Default value	Description
endCalled	boolean	false	-
modern	ScpClient | null	null	The v1 client behind this object.
remotePathSep	"/" | "\"	'/'	-
sftpWrapper	SFTPWrapper | null	null	-
sshClient	Client | null	null	-

Methods

[captureRejectionSymbol]()?

optional [captureRejectionSymbol](
   error, 
   event, 
   ...args
): void;

The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}

Parameters

Parameter	Type
error	Error
event	string | symbol
...args	any[]

Returns

void

Since

v13.4.0, v12.16.0

Inherited from

EventEmitter.[captureRejectionSymbol]

---

addListener()

addListener<E>(eventName, listener): this;

Alias for emitter.on(eventName, listener).

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args) => void

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.addListener

---

appendFile()

appendFile(
   remotePath, 
   data, 
   options?
): Promise<void>;

Parameters

Parameter	Type
remotePath	string
data	string | Buffer<ArrayBufferLike>
options	WriteFileOptions

Returns

Promise<void>

---

chmod()

chmod(path, mode): Promise<void>;

Parameters

Parameter	Type
path	string
mode	string | number

Returns

Promise<void>

---

chown()

chown(
   path, 
   uid, 
   gid
): Promise<void>;

Parameters

Parameter	Type
path	string
uid	number
gid	number

Returns

Promise<void>

---

close()

close(): Promise<void>;

Closes the connection. The returned promise resolves once it is closed.

Returns

Promise<void>

---

downloadDir()

downloadDir(remotePath, localPath): Promise<string>;

Downloads a remote directory. Resolves to a short summary message, like 0.x.

Parameters

Parameter	Type
remotePath	string
localPath	string

Returns

Promise<string>

---

downloadFile()

downloadFile(
   remotePath, 
   localPath, 
   options?
): Promise<void>;

Downloads a file using parallel reads.

Parameters

Parameter	Type
remotePath	string
localPath	string
options	TransferOptions

Returns

Promise<void>

---

emit()

emit<E>(eventName, ...args): boolean;

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol
...args	any[]

Returns

boolean

Since

v0.1.26

Inherited from

EventEmitter.emit

---

emptyDir()

emptyDir(dir): Promise<void>;

Makes dir an empty directory, creating it when missing.

Parameters

Parameter	Type
dir	string

Returns

Promise<void>

---

eventNames()

eventNames(): (string | symbol)[];

Returns an array listing the events for which the emitter has registered listeners.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

EventEmitter.eventNames

---

exists()

exists(remotePath): Promise<false | "-" | "d" | "l">;

Resolves to 'd', '-' or 'l', or false when the path does not exist.

Parameters

Parameter	Type
remotePath	string

Returns

Promise<false | "-" | "d" | "l">

---

getMaxListeners()

getMaxListeners(): number;

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

EventEmitter.getMaxListeners

---

list()

list(remotePath, pattern?): Promise<ListEntry[]>;

Lists a directory. pattern filters names, as a RegExp or a * wildcard string.

Parameters

Parameter	Type
remotePath	string
pattern	string | RegExp

Returns

Promise<ListEntry[]>

---

listenerCount()

listenerCount<E>(eventName, listener?): number;

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event being listened for
listener?	(...args) => void	The event handler function

Returns

number

Since

v3.2.0

Inherited from

EventEmitter.listenerCount

---

listeners()

listeners<E>(eventName): (...args) => void[];

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol

Returns

(...args) => void[]

Since

v0.1.26

Inherited from

EventEmitter.listeners

---

lstat()

lstat(path): Promise<Stats>;

Parameters

Parameter	Type
path	string

Returns

Promise<Stats>

---

mkdir()

mkdir(
   remotePath, 
   attributes?, 
   options?
): Promise<void>;

Creates a directory, with parents when recursive is set.

Parameters

Parameter	Type
remotePath	string
attributes	InputAttributes
options	{ recursive?: boolean; }
options.recursive?	boolean

Returns

Promise<void>

---

off()

off<E>(eventName, listener): this;

Alias for emitter.removeListener().

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args) => void

Returns

this

Since

v10.0.0

Inherited from

EventEmitter.off

---

on()

on<E>(eventName, listener): this;

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args) => void	The callback function

Returns

this

Since

v0.1.101

Inherited from

EventEmitter.on

---

once()

once<E>(eventName, listener): this;

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args) => void	The callback function

Returns

this

Since

v0.3.0

Inherited from

EventEmitter.once

---

prependListener()

prependListener<E>(eventName, listener): this;

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args) => void	The callback function

Returns

this

Since

v6.0.0

Inherited from

EventEmitter.prependListener

---

prependOnceListener()

prependOnceListener<E>(eventName, listener): this;

Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args) => void	The callback function

Returns

this

Since

v6.0.0

Inherited from

EventEmitter.prependOnceListener

---

rawListeners()

rawListeners<E>(eventName): (...args) => void[];

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol

Returns

(...args) => void[]

Since

v9.4.0

Inherited from

EventEmitter.rawListeners

---

readFile()

readFile(remotePath): Promise<Buffer<ArrayBufferLike>>;

Parameters

Parameter	Type
remotePath	string

Returns

Promise<Buffer<ArrayBufferLike>>

---

readlink()

readlink(path): Promise<string>;

Parameters

Parameter	Type
path	string

Returns

Promise<string>

---

realPath()

realPath(remotePath): Promise<string>;

Resolves remotePath to an absolute path.

Parameters

Parameter	Type
remotePath	string

Returns

Promise<string>

---

removeAllListeners()

removeAllListeners<E>(eventName?): this;

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName?	string | symbol

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeAllListeners

---

removeListener()

removeListener<E>(eventName, listener): this;

Removes the specified listener from the listener array for the event named eventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args) => void

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeListener

---

rename()

rename(srcPath, destPath): Promise<void>;

Parameters

Parameter	Type
srcPath	string
destPath	string

Returns

Promise<void>

---

rmdir()

rmdir(remotePath): Promise<void>;

Removes a directory and everything inside it.

Parameters

Parameter	Type
remotePath	string

Returns

Promise<void>

---

setMaxListeners()

setMaxListeners(n): this;

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Parameter	Type
n	number

Returns

this

Since

v0.3.5

Inherited from

EventEmitter.setMaxListeners

---

setstat()

setstat(path, attributes?): Promise<void>;

Parameters

Parameter	Type
path	string
attributes	InputAttributes

Returns

Promise<void>

---

stat()

stat(remotePath): Promise<Stats>;

Parameters

Parameter	Type
remotePath	string

Returns

Promise<Stats>

---

symlink()

symlink(targetPath, linkPath): Promise<void>;

Parameters

Parameter	Type
targetPath	string
linkPath	string

Returns

Promise<void>

---

unlink()

unlink(remotePath): Promise<void>;

Parameters

Parameter	Type
remotePath	string

Returns

Promise<void>

---

uploadDir()

uploadDir(src, dest): Promise<void>;

Uploads the contents of a local directory into dest, creating dest when missing.

Parameters

Parameter	Type
src	string
dest	string

Returns

Promise<void>

---

uploadFile()

uploadFile(
   localPath, 
   remotePath, 
   options?
): Promise<void>;

Uploads a file using parallel writes.

Parameters

Parameter	Type
localPath	string
remotePath	string
options	TransferOptions

Returns

Promise<void>

---

utimes()

utimes(
   path, 
   atime, 
   mtime
): Promise<void>;

Parameters

Parameter	Type
path	string
atime	number | Date
mtime	number | Date

Returns

Promise<void>

---

writeFile()

writeFile(
   remotePath, 
   data, 
   options?
): Promise<void>;

Parameters

Parameter	Type
remotePath	string
data	string | Buffer<ArrayBufferLike>
options	WriteFileOptions

Returns

Promise<void>