PluginApiError

@codebolt/plugin-sdk

---

Class: PluginApiError

Defined in: CodeBolt/packages/pluginSdk/src/core/httpClient.ts:3

Extends

• Error

Constructors

Constructor

new PluginApiError(
   message: string, 
   status: number, 
   statusText: string, 
   data?: any): PluginApiError;

Defined in: CodeBolt/packages/pluginSdk/src/core/httpClient.ts:4

Parameters

Parameter	Type
message	string
status	number
statusText	string
data?	any

Returns

PluginApiError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
data?	public	any	-	-	CodeBolt/packages/pluginSdk/src/core/httpClient.ts:8
message	public	string	-	Error.message	codeboltdocs/node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	Error.name	codeboltdocs/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?	public	string	-	Error.stack	codeboltdocs/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	CodeBolt/packages/pluginSdk/node_modules/@types/node/globals.d.ts:68
status	public	number	-	-	CodeBolt/packages/pluginSdk/src/core/httpClient.ts:6
statusText	public	string	-	-	CodeBolt/packages/pluginSdk/src/core/httpClient.ts:7

Methods

captureStackTrace()

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

Defined in: CodeBolt/packages/pluginSdk/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: CodeBolt/packages/pluginSdk/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