hook

Documentation

Index

• func AliasForEvent(name HookName) (string, bool)
• type Decision
  • func NormalizeDecision(value string) (Decision, bool)
• type Event
• type EventAlias
• type HookName
  • func ParseEventAlias(value string) (HookName, bool)
  • func (h HookName) CanBlock() bool
  • func (h HookName) IsKnown() bool
  • func (h HookName) String() string
• type Result
  • func WithMetadata(result Result, metadata any) Result
  • func (r Result) Allowed() bool
  • func (r Result) Blocking() bool
  • func (r Result) ClaudeReason() string
  • func (r Result) Metadata() any

Functions

func AliasForEvent

func AliasForEvent(name HookName) (string, bool)

Types

type Decision

type Decision string

const (
	DecisionAllow Decision = "allow"
	DecisionDeny  Decision = "deny"
)

func NormalizeDecision

func NormalizeDecision(value string) (Decision, bool)

type Event

type Event struct {
	SessionID      string
	Agent          string
	HookName       HookName
	ToolName       string
	ToolInput      map[string]any
	ToolResponse   map[string]any
	ToolUseID      string
	CWD            string
	PermissionMode string
	DurationMs     *int64
	Error          string
	IsInterrupt    *bool
}

type EventAlias

type EventAlias struct {
	Name  HookName
	Alias string
}

type HookName

type HookName string

const (
	HookSessionStart      HookName = "SessionStart"
	HookPreToolUse        HookName = "PreToolUse"
	HookPostToolUse       HookName = "PostToolUse"
	HookPostToolUseFailed HookName = "PostToolUseFailure"
	HookSessionEnd        HookName = "SessionEnd"
	HookUserPromptSubmit  HookName = "UserPromptSubmit"
	HookStop              HookName = "Stop"
)

func ParseEventAlias

func ParseEventAlias(value string) (HookName, bool)

func (HookName) CanBlock

func (h HookName) CanBlock() bool

func (HookName) IsKnown

func (h HookName) IsKnown() bool

func (HookName) String

func (h HookName) String() string

type Result

type Result struct {
	Decision     Decision
	Reason       string
	ReasonCode   string
	RequestID    string
	EventID      string
	Mode         string
	Epoch        string
	UpdatedInput map[string]any
	// contains filtered or unexported fields
}

func WithMetadata

func WithMetadata(result Result, metadata any) Result

func (Result) Allowed

func (r Result) Allowed() bool

func (Result) Blocking

func (r Result) Blocking() bool

func (Result) ClaudeReason

func (r Result) ClaudeReason() string

func (Result) Metadata

func (r Result) Metadata() any