self-assert

Appearance

self-assert / RulesBroken

Class: RulesBroken ​

Provides a way to handle multiple failed rules, by their labels.

See ​

RuleLabel

Extends ​

  • Error

Constructors ​

Constructor ​

new RulesBroken(brokenRules): RulesBroken

Parameters ​

ParameterType
brokenRulesLabeledRule[]

Returns ​

RulesBroken

Overrides ​

Error.constructor

Creation ​

fromJson() ​

static fromJson(rulesBrokenAsJson): RulesBroken

Parameters ​

ParameterType
rulesBrokenAsJsonRulesBrokenAsJson

Returns ​

RulesBroken

Inspection ​

hasRuleBrokenWith() ​

hasRuleBrokenWith(labelId, labelDescription): boolean

Parameters ​

ParameterType
labelIdstring
labelDescriptionstring

Returns ​

boolean

hasOnlyOneRuleBrokenWith() ​

hasOnlyOneRuleBrokenWith(labelId, labelDescription): boolean

Parameters ​

ParameterType
labelIdstring
labelDescriptionstring

Returns ​

boolean

forEachRuleBroken() ​

forEachRuleBroken(closure): void

Parameters ​

ParameterType
closure(brokenRule) => void

Returns ​

void

Others ​

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): 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.

js
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:

js
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 ​

ParameterType
targetObjectobject
constructorOpt?Function

Returns ​

void

Inherited from ​

Error.captureStackTrace

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Parameters ​

ParameterType
errError
stackTracesCallSite[]

Returns ​

any

See ​

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

Inherited from ​

Error.prepareStackTrace

stackTraceLimit ​

static 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.

Inherited from ​

Error.stackTraceLimit

name ​

name: string

Inherited from ​

Error.name

message ​

message: string

Inherited from ​

Error.message

stack? ​

optional stack: string

Inherited from ​

Error.stack

cause? ​

optional cause: unknown

Inherited from ​

Error.cause