Class: InvalidOptionError

The caller passed something the library cannot use — a non-finite coordinate, an unknown enum value, a required option left out, a value outside its legal range.

This is the error behind the project's throw-rather-than-coerce policy: emitting a degenerate result (a zero-size shape, a silently dropped option) hides the mistake, so the library refuses instead. Reaching one means the calling code needs to change.

Extends

• TsPptxError

Constructors

Constructor

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

Parameters

Parameter	Type
code	InvalidOptionErrorCode
message	string
options?	TsPptxErrorOptions

Returns

InvalidOptionError

Overrides

TsPptxError.constructor

Properties

cause?

optional cause?: unknown

Inherited from

TsPptxError.cause

---

code

readonly code: InvalidOptionErrorCode

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