ApiError

@hyperledger/identus-sdk v8.0.0

---

@hyperledger/identus-sdk / overview / Domain / ApiError

Class: ApiError

Defined in: packages/shared/domain/build/index.d.ts:232

Extends

• Error

Constructors

Constructor

new ApiError(status: number, statusText: string, body: any): ApiError

Defined in: packages/shared/domain/build/index.d.ts:236

Parameters

Parameter	Type
status	number
statusText	string
body	any

Returns

ApiError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
body	readonly	any	-	-	packages/shared/domain/build/index.d.ts:235
cause?	public	unknown	-	Error.cause	node_modules/typescript/lib/lib.es2022.error.d.ts:26
message	public	string	-	Error.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	Error.name	node_modules/typescript/lib/lib.es5.d.ts:1076
stack?	public	string	-	Error.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
status	readonly	number	-	-	packages/shared/domain/build/index.d.ts:233
statusText	readonly	string	-	-	packages/shared/domain/build/index.d.ts:234
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/@types/node/globals.d.ts:68

Methods

captureStackTrace()

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

Defined in: 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

---

prepareStackTrace()

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

Defined in: 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