Skip to content

PromptScript API


Interface: HookDefinition

Defined in: formatters/src/hook-adapters.ts:19

A parsed hook definition from the

Hooks

block.

Properties

command

command: string[]

Defined in: formatters/src/hook-adapters.ts:27

Command arguments (non-empty array).


continueOnFailure?

optional continueOnFailure?: boolean

Defined in: formatters/src/hook-adapters.ts:33

Whether to continue if the hook fails.


enabled?

optional enabled?: boolean

Defined in: formatters/src/hook-adapters.ts:35

Whether the hook is enabled.


event

event: PortableHookEvent

Defined in: formatters/src/hook-adapters.ts:23

Portable event name.


id

id: string

Defined in: formatters/src/hook-adapters.ts:21

Stable hook ID (from object key).


matcher?

optional matcher?: string

Defined in: formatters/src/hook-adapters.ts:25

Tool name matcher pattern (optional).


statusMessage?

optional statusMessage?: string

Defined in: formatters/src/hook-adapters.ts:31

Status message shown during execution.


timeoutMs?

optional timeoutMs?: number

Defined in: formatters/src/hook-adapters.ts:29

Timeout in milliseconds.