InvalidFilterOperatorValueError

src/errors/invalid-filter-operator-value.error.ts2 public methodsclass

Thrown when a filter operator receives a value array of the wrong shape

Some operators have arity or type constraints that the library enforces at call time so misuse fails loudly instead of silently emitting invalid server requests:

• BTW requires exactly two values (min, max).
• NULL requires exactly one boolean value (true for IS NULL, false for IS NOT NULL).

Operators with looser shape rules leave validation to the server; this error is reserved for cases where the library itself can detect the problem unambiguously from the call site.

Constructor

new InvalidFilterOperatorValueError(operator: FilterOperatorEnum, reason: string)

Parameter	Type	Description
operator	FilterOperatorEnum	The operator that rejected the values
reason	string	Short human-readable explanation of the constraint

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.
message	string	—
name	string	—
operator	FilterOperatorEnum	The operator that rejected the values.
reason	string	Why the values were rejected.
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[]	—