agents / Exports / TypeSafePluginInterface
Interface: TypeSafePluginInterface<TOptions, TStats>
Type-safe plugin interface with specific type parameters
Type parameters
| Name | Type | Description |
|---|---|---|
TOptions | extends BasePluginOptions = BasePluginOptions | Plugin options type that extends BasePluginOptions |
TStats | PluginStats | Plugin statistics type (defaults to PluginStats for type safety) |
Hierarchy
TypeSafePluginInterface
Implemented by
Table of contents
Properties
Methods
Properties
name
• name: string
Defined in
packages/agents/src/abstracts/base-plugin.ts:156
version
• version: string
Defined in
packages/agents/src/abstracts/base-plugin.ts:157
enabled
• enabled: boolean
Defined in
packages/agents/src/abstracts/base-plugin.ts:158
category
• category: PluginCategory
Defined in
packages/agents/src/abstracts/base-plugin.ts:159
priority
• priority: number
Defined in
packages/agents/src/abstracts/base-plugin.ts:160
Methods
initialize
▸ initialize(options?): Promise<void>
Parameters
| Name | Type |
|---|---|
options? | TOptions |
Returns
Promise<void>
Defined in
packages/agents/src/abstracts/base-plugin.ts:162
cleanup
▸ cleanup(): Promise<void>
Returns
Promise<void>
Defined in
packages/agents/src/abstracts/base-plugin.ts:163
getData
▸ getData(): PluginData
Returns
Defined in
packages/agents/src/abstracts/base-plugin.ts:164
getStats
▸ getStats(): TStats
Returns
TStats
Defined in
packages/agents/src/abstracts/base-plugin.ts:165
subscribeToModuleEvents
▸ subscribeToModuleEvents(eventEmitter): Promise<void>
Parameters
| Name | Type |
|---|---|
eventEmitter | EventEmitterPlugin |
Returns
Promise<void>
Defined in
packages/agents/src/abstracts/base-plugin.ts:168
unsubscribeFromModuleEvents
▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>
Parameters
| Name | Type |
|---|---|
eventEmitter | EventEmitterPlugin |
Returns
Promise<void>
Defined in
packages/agents/src/abstracts/base-plugin.ts:169
onModuleEvent
▸ onModuleEvent(eventType, eventData): void | Promise<void>
Parameters
| Name | Type |
|---|---|
eventType | EventType |
eventData | EventData |
Returns
void | Promise<void>