Skip to content
Surface: Runtime NodeStability: Public StableMaturity: StableSource

Claude App

通过 TypeDoc 和 typedoc-plugin-markdown 生成。

Defined in: index.d.ts:39

Minimal Claude hook app that dispatches supported hook names to registered handlers.

Constructors

Constructor

> new ClaudeApp(options): ClaudeApp

Defined in: index.d.ts:46

Creates a Claude runtime app.

Parameters

options
allowedHooks

readonly string[] | string[]

Hook names that this binary accepts on argv.

usage

string

Usage string printed when the invocation is invalid.

Returns

ClaudeApp

Methods

on()

> on(hookName, handler): this

Defined in: index.d.ts:50

Registers a handler for an arbitrary Claude hook name.

Parameters

hookName

string

handler

ClaudeHandler

Returns

this


onPreToolUse()

> onPreToolUse(handler): this

Defined in: index.d.ts:58

Registers a handler for the PreToolUse hook.

Parameters

handler

ClaudeHandler

Returns

this


onStop()

> onStop(handler): this

Defined in: index.d.ts:54

Registers a handler for the Stop hook.

Parameters

handler

ClaudeHandler

Returns

this


onUserPromptSubmit()

> onUserPromptSubmit(handler): this

Defined in: index.d.ts:62

Registers a handler for the UserPromptSubmit hook.

Parameters

handler

ClaudeHandler

Returns

this


run()

> run(): number

Defined in: index.d.ts:66

Dispatches the current process invocation and returns the exit code.

Returns

number

面向插件作者和集成者的公共文档。