@dice-roller/rpg-dice-roller / errors / NotationError

Class: NotationError

Defined in: src/errors/NotationError.ts:20

Thrown when the notation is syntactically invalid. Empty or non-string notation instead raises a ValidationError. Parser syntax errors retain the original notation, the start location, and the underlying syntax error as cause; a manually constructed error may omit location and cause.

Extends

• DiceRollerError

Constructors

Constructor

new NotationError(message, notation, location?, options?): NotationError

Defined in: src/errors/NotationError.ts:27

Parameters

message

string

the error message

notation

string

the original notation

location?

NotationErrorLocation

the optional start of the syntax error

options?

ErrorOptions

optional native error options, including cause

Returns

NotationError

Overrides

DiceRollerError.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

DiceRollerError.cause

---

location?

readonly optional location?: NotationErrorLocation

Defined in: src/errors/NotationError.ts:30

the optional start of the syntax error

---

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

DiceRollerError.message

---

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

DiceRollerError.name

---

notation

readonly notation: string

Defined in: src/errors/NotationError.ts:29

the original notation

---

stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

DiceRollerError.stack

---

stackTraceLimit

static stackTraceLimit: number

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

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

DiceRollerError.stackTraceLimit

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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

DiceRollerError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

DiceRollerError.prepareStackTrace