Class: InternalError

An invariant the library maintains itself did not hold.

No consumer input should be able to produce one, which is the whole reason it is a separate class: seeing it means the bug is in ts-pptx, and the useful response is to file it rather than to keep adjusting the input.

It is the one class in the taxonomy that extends its own message, appending REPORT_NOTICE below the invariant that broke. The constructor is where that lives so a throw site added later inherits it — the alternative, a notice pasted at each of the sites, is one every future site can forget. Every other class leaves message exactly as given: a malformed package is the routine outcome for a library that reads untrusted files, and a "report this" banner on each corrupt input would train callers to ignore the one banner that always means something.

This does not make the message API — see the class doc on TsPptxError. Branch on instanceof or on InternalError.code, never on the text.

Extends

• TsPptxError

Constructors

Constructor

new InternalError(code, message, options?): InternalError

Parameters

Parameter	Type
code	InternalErrorCode
message	string
options?	TsPptxErrorOptions

Returns

InternalError

Overrides

TsPptxError.constructor

Properties

cause?

optional cause?: unknown

Inherited from

TsPptxError.cause

---

code

readonly code: InternalErrorCode

Stable condition identifier — see ErrorCode. Branch on this, not on the text.

Overrides

TsPptxError.code

---

detail?

readonly optional detail?: Readonly<Record<string, unknown>>

Structured context for the condition, when the throwing site had any to give.

Inherited from

TsPptxError.detail

---

message

message: string

Inherited from

TsPptxError.message

---

name

name: string

Inherited from

TsPptxError.name

---

stack?

optional stack?: string

Inherited from

TsPptxError.stack

---

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

TsPptxError.stackTraceLimit

Methods

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.

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

TsPptxError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

TsPptxError.prepareStackTrace