AIDK API Reference / aidk/component / ComponentHookRegistry

Class: ComponentHookRegistry

Defined in: packages/core/src/component/component-hooks.ts:94

Component-specific hook registry. Uses BaseHookRegistry to reduce code duplication while supporting component selectors.

Extends

• BaseHookRegistry<ComponentHookName, ComponentSelector, ComponentHookMiddleware<ComponentHookName>>

Constructors

Constructor

new ComponentHookRegistry(): ComponentHookRegistry;

Defined in: packages/core/src/hooks/base-hook-registry.ts:10

Returns

ComponentHookRegistry

Inherited from

BaseHookRegistry.constructor

Methods

copyHooksFrom()

copyHooksFrom(sourceRegistry: BaseHookRegistry<ComponentHookName, ComponentSelector, ComponentHookMiddleware<ComponentHookName>>): void;

Defined in: packages/core/src/hooks/base-hook-registry.ts:91

Copy all hooks from another registry of the same type. Useful for inheriting hooks from parent engine to child engine.

Parameters

Parameter	Type	Description
sourceRegistry	BaseHookRegistry<ComponentHookName, ComponentSelector, ComponentHookMiddleware<ComponentHookName>>	The registry to copy hooks from

Returns

void

Inherited from

BaseHookRegistry.copyHooksFrom

---

getMiddleware()

getMiddleware<T>(
   hookName: T, 
   componentClass: any, 
   componentName: string, 
   componentTags: string[]): ComponentHookMiddleware<T>[];

Defined in: packages/core/src/component/component-hooks.ts:118

Get all middleware for a component hook, ordered by specificity. Order: component-defined -> class-based -> tag-based -> name-based -> global

Type Parameters

Type Parameter
T extends ComponentHookName

Parameters

Parameter	Type
hookName	T
componentClass	any
componentName	string
componentTags	string[]

Returns

ComponentHookMiddleware<T>[]

---

register()

Call Signature

register<T>(
   hookName: T, 
   selector: ComponentSelector, 
   middleware: ComponentHookMiddleware): void;

Defined in: packages/core/src/hooks/base-hook-registry.ts:38

Register middleware for a hook.

Overloads:

• register(hookName, selector, middleware) - specific hook, specific selector
• register(hookName, middleware) - specific hook, global selector
• register(selector, middleware) - all hooks, specific selector (if selectors are supported)
• register(middleware) - all hooks, global selector

Type Parameters

Type Parameter
T extends ComponentHookName

Parameters

Parameter	Type
hookName	T
selector	ComponentSelector
middleware	ComponentHookMiddleware

Returns

void

Inherited from

BaseHookRegistry.register

Call Signature

register<T>(hookName: T, middleware: ComponentHookMiddleware): void;

Defined in: packages/core/src/hooks/base-hook-registry.ts:43

Register middleware for a hook.

Overloads:

• register(hookName, selector, middleware) - specific hook, specific selector
• register(hookName, middleware) - specific hook, global selector
• register(selector, middleware) - all hooks, specific selector (if selectors are supported)
• register(middleware) - all hooks, global selector

Type Parameters

Type Parameter
T extends ComponentHookName

Parameters

Parameter	Type
hookName	T
middleware	ComponentHookMiddleware

Returns

void

Inherited from

BaseHookRegistry.register

Call Signature

register(selector: ComponentSelector, middleware: ComponentHookMiddleware): void;

Defined in: packages/core/src/hooks/base-hook-registry.ts:44

Register middleware for a hook.

Overloads:

• register(hookName, selector, middleware) - specific hook, specific selector
• register(hookName, middleware) - specific hook, global selector
• register(selector, middleware) - all hooks, specific selector (if selectors are supported)
• register(middleware) - all hooks, global selector

Parameters

Parameter	Type
selector	ComponentSelector
middleware	ComponentHookMiddleware

Returns

void

Inherited from

BaseHookRegistry.register

Call Signature

register(middleware: ComponentHookMiddleware): void;

Defined in: packages/core/src/hooks/base-hook-registry.ts:45

Register middleware for a hook.

Overloads:

• register(hookName, selector, middleware) - specific hook, specific selector
• register(hookName, middleware) - specific hook, global selector
• register(selector, middleware) - all hooks, specific selector (if selectors are supported)
• register(middleware) - all hooks, global selector

Parameters

Parameter	Type
middleware	ComponentHookMiddleware

Returns

void

Inherited from

BaseHookRegistry.register