tyneq

---

tyneq / PluginError

Class: PluginError

Defined in: src/core/errors/PluginError.ts:17

Thrown when a plugin, decorator (@operator, @terminal), or factory (createOperator, createTerminalOperator) is used incorrectly.

Example

// @operator('myOp') applied to a class that doesn't extend TyneqEnumerator
// throws PluginError with decoratorName = "operator" and targetName = "MyOp"

See

TyneqError

Extends

• TyneqError

Constructors

Constructor

new PluginError(message, decoratorName, targetName?, inner?): PluginError

Defined in: src/core/errors/PluginError.ts:29

Parameters

Parameter	Type
message	string
decoratorName	string
targetName?	string
inner?	Error

Returns

PluginError

Overrides

TyneqError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
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.	TyneqError.stackTraceLimit	node_modules/@types/node/globals.d.ts:67
decoratorName	readonly	string	The name of the decorator or factory that produced the error. e.g. "operator", "terminal", "createOperator".	-	src/core/errors/PluginError.ts:22
targetName	readonly	Maybe<string>	The name of the class or function the decorator was applied to, if available.	-	src/core/errors/PluginError.ts:27
inner	public	Maybe<Error>	The underlying error that caused this error, if any.	TyneqError.inner	src/core/errors/TyneqError.ts:17
name	public	string	-	TyneqError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
message	public	string	-	TyneqError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
stack?	public	string	-	TyneqError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

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

TyneqError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

TyneqError.prepareStackTrace