Class: ScpError

The error type of every failure that leaves node-scp. Branch on ScpError.code, which means the same over SFTP and SCP; the original error is kept as cause.

Extends

• Error

Constructors

Constructor

new ScpError(
   code, 
   message, 
   options?
): ScpError;

Parameters

Parameter	Type
code	ErrorCode
message	string
options	ScpErrorOptions

Returns

ScpError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from
cause?	public	unknown	undefined	-	-	Error.cause
code	readonly	ErrorCode	undefined	Stable code describing what went wrong.	-	-
message	public	string	undefined	-	-	Error.message
name	readonly	"ScpError"	'ScpError'	-	Error.name	-
path	readonly	string | undefined	undefined	The local or remote path involved, when there is one.	-	-
stack?	public	string	undefined	-	-	Error.stack
stackTraceLimit	static	number	undefined	The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	-	Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace