Function: parseInterruptSpec()
parseInterruptSpec(
raw): {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:275
Parameters
raw
unknown
Returns
Type Literal
{ cancelLabel?: string; confirmLabel?: string; id?: string; kind: "confirm"; metadata?: Record<string, unknown>; prompt: string; }
cancelLabel?
optionalcancelLabel?:string
confirmLabel?
optionalconfirmLabel?:string
id?
optionalid?:string
kind
kind:
"confirm"
metadata?
optionalmetadata?: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?
optionalid?:string
kind
kind:
"text"
maxLength?
optionalmaxLength?:number
metadata?
optionalmetadata?:Record<string,unknown>
Opaque host correlation/presentation hints, persisted with the interrupt.
placeholder?
optionalplaceholder?:string
prompt
prompt:
string
Type Literal
{ id?: string; kind: "choice"; metadata?: Record<string, unknown>; multiple?: boolean; options: object[]; prompt: string; }
id?
optionalid?:string
kind
kind:
"choice"
metadata?
optionalmetadata?:Record<string,unknown>
Opaque host correlation/presentation hints, persisted with the interrupt.
multiple?
optionalmultiple?: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?
optionalid?:string
kind
kind:
"number"
max
max:
number
metadata?
optionalmetadata?:Record<string,unknown>
Opaque host correlation/presentation hints, persisted with the interrupt.
min
min:
number
prompt
prompt:
string
step?
optionalstep?:number
Type Literal
{ accept?: string[]; id?: string; kind: "file"; maxBytes?: number; metadata?: Record<string, unknown>; prompt: string; }
accept?
optionalaccept?:string[]
id?
optionalid?:string
kind
kind:
"file"
maxBytes?
optionalmaxBytes?:number
metadata?
optionalmetadata?: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?
optionalid?:string
kind
kind:
"encrypted"
metadata?
optionalmetadata?:Record<string,unknown>
Opaque host correlation/presentation hints, persisted with the interrupt.
prompt
prompt:
string
purpose?
optionalpurpose?:"password"|"secret"|"api_key"