OMSSServerError

Returned when an error gets Returned in the OMSSServer class.

return ERR(OMSSServerError('config.name must be a non-empty string', {cause: config}))

class OMSSServerError extends OMSSError

Constructor

OMSSServerError(message: string, options?: { cause: unknown }): OMSSServerError

Create a new OMSSError.

Parameters

message · string · required

Error message

options · { cause: unknown }

Additional options for the error

Returns

OMSSServerError

Properties

cause · unknown

message · string · required

name · string · required

stack · string

stackTraceLimit · number · required

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.

Methods

captureStackTrace()

captureStackTrace(targetObject: object, constructorOpt?: Function): 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

targetObject · object · required

constructorOpt · Function

prepareStackTrace()

prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Parameters

err · Error · required

stackTraces · CallSite[] · required

Returns

any