ErrorFlow

Error type used to propagate errors through flows between bricks.

Extends

• Error

Constructors

Constructor

new ErrorFlow(message?): ErrorFlow;

Parameters

Parameter	Type
message?	string

Returns

ErrorFlow

Inherited from

Error.constructor

Properties

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

Error.stackTraceLimit

---

message

message: string;

Inherited from

Error.message

---

name

name: string;

Inherited from

Error.name

---

stack?

optional stack: string;

Inherited from

Error.stack

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

---

create()

static create(message, code): ErrorFlow;

Create a new Error object to be sent in an error flow

Parameters

Parameter	Type	Description
message	string	the error message
code	number	the code associated to the error

Returns

ErrorFlow

---

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

---

getCode()

getCode(): number;

Return the code associated to this error

Returns

number

---

getMessage()

getMessage(): string;

Return the message of this error

Returns

string

---

getStack()

getStack(): string;

Return the stack with the hierarchy of bricks that run the one having thrown the error.

Returns

string