Class: InvalidAskComponentError

An ask nominated a component this run cannot honor as stated — a malformed shape, a propsRef with no artifact store attached, or a propsRef that does not resolve in the run's own scope.

Raised AT THE SOURCE — the moment the ask is raised — and it fails the run loudly rather than pausing: a pause whose component the screen cannot render is a question a person half-receives, and a consent gate silently downgraded to prose (or to nothing) is the accepted-and-silently-wrong failure this refusal exists to prevent. The author fixes the ask; nothing was executed behind anyone's back.

Extends

Error

Constructors

Constructor

new InvalidAskComponentError(reason, door, detail, ref?): InvalidAskComponentError

Defined in: src/core/askComponent.ts:98

Parameters

reason

AskComponentRefusalReason

door

string

detail

string

ref?

string

Returns

InvalidAskComponentError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

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

Inherited from

Error.cause

code

readonly code: "ERR_INVALID_ASK_COMPONENT"

Defined in: src/core/askComponent.ts:89

door

readonly door: string

Defined in: src/core/askComponent.ts:94

The door the component arrived through (askHuman, ask middleware '<name>', tool '<name>' checkInComponent, …).

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

reason

readonly reason: AskComponentRefusalReason

Defined in: src/core/askComponent.ts:91

Which rule refused.

ref?

readonly optional ref?: string

Defined in: src/core/askComponent.ts:96

The ref that could not be honored, when the refusal is about one.

stack?

optional stack?: string

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

Inherited from

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

Error.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();

static prepareStackTrace(err, stackTraces): any

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

InvalidAskComponentError

On this page