Skip to main content

Class: InterruptSignal

Defined in: packages/core/src/interrupt/types.ts:154

Extends​

  • Error

Constructors​

Constructor​

new InterruptSignal(request): InterruptSignal

Defined in: packages/core/src/interrupt/types.ts:161

Parameters​

request​

InterruptRequest

Returns​

InterruptSignal

Overrides​

Error.constructor

Properties​

[INTERRUPT_SIGNAL]​

readonly [INTERRUPT_SIGNAL]: true = true

Defined in: packages/core/src/interrupt/types.ts:155


cause?​

optional cause?: unknown

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

Error.cause


interruptId​

readonly interruptId: string

Defined in: packages/core/src/interrupt/types.ts:156


message​

message: string

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

Inherited from​

Error.message


name​

name: string

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

Inherited from​

Error.name


spec​

readonly spec: { cancelLabel?: string; confirmLabel?: string; id?: string; kind: "confirm"; metadata?: Record<string, unknown>; prompt: string; } | { id?: string; kind: "text"; maxLength?: number; metadata?: Record<string, unknown>; placeholder?: string; prompt: string; } | { id?: string; kind: "choice"; metadata?: Record<string, unknown>; multiple?: boolean; options: object[]; prompt: string; } | { id?: string; kind: "number"; max: number; metadata?: Record<string, unknown>; min: number; prompt: string; step?: number; } | { accept?: string[]; id?: string; kind: "file"; maxBytes?: number; metadata?: Record<string, unknown>; prompt: string; } | { id?: string; kind: "encrypted"; metadata?: Record<string, unknown>; prompt: string; purpose?: "password" | "secret" | "api_key"; }

Defined in: packages/core/src/interrupt/types.ts:159

Union Members​

Type Literal​

{ cancelLabel?: string; confirmLabel?: string; id?: string; kind: "confirm"; metadata?: Record<string, unknown>; prompt: string; }

cancelLabel?​

optional cancelLabel?: string

confirmLabel?​

optional confirmLabel?: string

id?​

optional id?: string

kind​

kind: "confirm"

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "text"; maxLength?: number; metadata?: Record<string, unknown>; placeholder?: string; prompt: string; }

id?​

optional id?: string

kind​

kind: "text"

maxLength?​

optional maxLength?: number

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

placeholder?​

optional placeholder?: string

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "choice"; metadata?: Record<string, unknown>; multiple?: boolean; options: object[]; prompt: string; }

id?​

optional id?: string

kind​

kind: "choice"

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

multiple?​

optional multiple?: boolean

options​

options: object[]

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "number"; max: number; metadata?: Record<string, unknown>; min: number; prompt: string; step?: number; }

id?​

optional id?: string

kind​

kind: "number"

max​

max: number

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

min​

min: number

prompt​

prompt: string

step?​

optional step?: number


Type Literal​

{ accept?: string[]; id?: string; kind: "file"; maxBytes?: number; metadata?: Record<string, unknown>; prompt: string; }

accept?​

optional accept?: string[]

id?​

optional id?: string

kind​

kind: "file"

maxBytes?​

optional maxBytes?: number

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "encrypted"; metadata?: Record<string, unknown>; prompt: string; purpose?: "password" | "secret" | "api_key"; }

id?​

optional id?: string

kind​

kind: "encrypted"

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

prompt​

prompt: string

purpose?​

optional purpose?: "password" | "secret" | "api_key"


stack?​

optional stack?: string

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

Inherited from​

Error.stack


toolCallId​

readonly toolCallId: string

Defined in: packages/core/src/interrupt/types.ts:157


toolName​

readonly toolName: string

Defined in: packages/core/src/interrupt/types.ts:158


stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:68

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/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:52

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​

Error.captureStackTrace


prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace