Interface: HookEntry<Event>

Generated from the public TypeScript API.

A hook callback with an optional tool matcher, deadline and asynchronous-notification flag.

​

Type Parameters

​

Event

Event extends HookEventName = HookEventName

​

Properties

​

async?

optional async?: boolean;

---

​

callback

callback: (payload) =>
  | void
  | HookResult
| Promise<void | HookResult>;

The SDK-local event handler. Decision fields are honored only for supported event types.

Handle an event in the SDK process.

​

Parameters

payload

HookEventPayload<Event>

Event data and cancellation signal.

​

Returns

| void | HookResult | Promise<void | HookResult>

Optional event-specific modifications or decisions.

---

​

matcher?

optional matcher?: string | RegExp;

---

​

timeoutMs?

optional timeoutMs?: number;