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