DuplicateListParamError

src/errors/duplicate-list-param.error.ts2 public methodsclass

Thrown by defineList() when two params share a page-URL key, or when a param’s key is empty.

Two params reading one key would fight over it — every link would write the key twice — so the list is refused where it is declared, at module load, rather than misbehaving later.

Constructor

new DuplicateListParamError(key: string, names: readonly string[])

Parameter	Type	Description
key	string	The contested key, or ''
names	readonly string[]	The state names of the params holding it

Properties

Property	Type	Description
cause	unknown	—
code	QubeeErrorCode	Machine-readable identifier for this failure.
context	Record<string, unknown>	The values that produced the error, when they aid diagnosis.
key	string	The contested key — '' when the problem is an empty key.
message	string	—
name	string	—
names	readonly string[]	The state names of the params holding key.
stack	string	—
stackTraceLimit	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.

Methods

captureStackTrace()

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

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();

Parameter	Type	Description
targetObject	object	—
constructorOpt	Function	—

prepareStackTrace()

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

Parameter	Type	Description
err	Error	—
stackTraces	CallSite[]	—