@saflib/jobs-db

---

Class: JobsDatabaseError

Superclass for all handled jobs db errors

Extends

• HandledDatabaseError

Extended by

• JobSpawnCapExceededError
• JobNotFoundError
• JobNotRunningError
• JobNotCancellableError
• JobNotRetryableError

Constructors

Constructor

new JobsDatabaseError(message?): JobsDatabaseError

Parameters

Parameter	Type
message?	string

Returns

JobsDatabaseError

Inherited from

HandledDatabaseError.constructor

Constructor

new JobsDatabaseError(message?, options?): JobsDatabaseError

Parameters

Parameter	Type
message?	string
options?	ErrorOptions

Returns

JobsDatabaseError

Inherited from

HandledDatabaseError.constructor

Properties

cause?

optional cause: unknown

Inherited from

HandledDatabaseError.cause

---

message

message: string

Inherited from

HandledDatabaseError.message

---

name

name: string

Inherited from

HandledDatabaseError.name

---

stack?

optional stack: string

Inherited from

HandledDatabaseError.stack

---

stackTraceLimit

static stackTraceLimit: number

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.

Inherited from

HandledDatabaseError.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

HandledDatabaseError.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

HandledDatabaseError.prepareStackTrace