@sora-soft/framework

---

@sora-soft/framework / ExError

Class: ExError

Defined in: packages/framework/src/utility/ExError.ts:10

Extends

• Error

Extended by

• ConnectorError
• RouteError
• RPCError
• RPCResponseError
• RefError
• RetryError
• TCPError
• TraceError
• FrameworkError
• TimeoutError

Constructors

Constructor

new ExError(
   code, 
   name, 
   message, 
   level, 
   args): ExError;

Defined in: packages/framework/src/utility/ExError.ts:21

Parameters

Parameter	Type
code	string
name	string
message	string
level	ErrorLevel
args	ErrorArgs

Returns

ExError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	Error.cause	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
message	public	string	-	Error.message	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
stack?	public	string	-	Error.stack	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimit	static	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.	Error.stackTraceLimit	node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/globals.d.ts:68

Accessors

args

Get Signature

get args(): ErrorArgs;

Defined in: packages/framework/src/utility/ExError.ts:42

Returns

ErrorArgs

---

code

Get Signature

get code(): string;

Defined in: packages/framework/src/utility/ExError.ts:30

Returns

string

---

level

Get Signature

get level(): ErrorLevel;

Defined in: packages/framework/src/utility/ExError.ts:38

Returns

ErrorLevel

---

name

Get Signature

get name(): string;

Defined in: packages/framework/src/utility/ExError.ts:34

Returns

string

Overrides

Error.name

Methods

toJson()

toJson(): any;

Defined in: packages/framework/src/utility/ExError.ts:46

Returns

any

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/globals.d.ts:52

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

---

fromError()

static fromError(err): ExError;

Defined in: packages/framework/src/utility/ExError.ts:11

Parameters

Parameter	Type
err	Error | ExError

Returns

ExError

---

isError()

static isError(error): error is Error;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Parameter	Type
error	unknown

Returns

error is Error

Inherited from

Error.isError

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace