ApiError
ODP Node SDK / ODP / ApiError
Class: ApiError
Defined in: src/Api/lib/ApiError.ts:3
Extends
Extended by
Constructors
Constructor
Defined in: src/Api/lib/ApiError.ts:4
Parameters
source
Returns
ApiError
Overrides
Properties
cause?
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code?
Defined in: src/Api/lib/ApiV3.ts:77
Inherited from
message
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
response?
Defined in: src/Api/lib/ApiV3.ts:78
Inherited from
stack?
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
stackTraceLimit
Defined in: 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
Methods
captureStackTrace()
Defined in: 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
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
prepareStackTrace()
Defined in: node_modules/@types/node/globals.d.ts:149
Parameters
err
Error
stackTraces
CallSite[]
Returns
any