Class: ResultError<E>

Defined in: projects/utilities/packages/result/src/lib/ResultError.ts:1

Extends

• Error

Type Parameters

Type Parameter
E

Constructors

Constructor

new ResultError<E>(message: string, value: E): ResultError<E>

Defined in: projects/utilities/packages/result/src/lib/ResultError.ts:4

Parameters

Parameter	Type
message	string
value	E

Returns

ResultError<E>

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

---

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

---

value

readonly value: E

Defined in: projects/utilities/packages/result/src/lib/ResultError.ts:2

---

stackTraceLimit

static stackTraceLimit: number

Defined in: projects/utilities/node_modules/@types/node/globals.d.ts:161

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

Accessors

name

Get Signature

get name(): string

Defined in: projects/utilities/packages/result/src/lib/ResultError.ts:9

Returns

string

Overrides

Error.name

Methods

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void

Defined in: projects/utilities/node_modules/@types/node/globals.d.ts:145

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: Error, stackTraces: CallSite[]): any

Defined in: projects/utilities/node_modules/@types/node/globals.d.ts:149

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace