agents / Exports / BasePluginInterface
Interface: BasePluginInterface
Base plugin interface extending TypeSafePluginInterface
Hierarchy
TypeSafePluginInterface<PluginConfig,PluginStats>↳
BasePluginInterface
Table of contents
Properties
Methods
Properties
name
• name: string
Inherited from
Defined in
packages/agents/src/abstracts/base-plugin.ts:156
version
• version: string
Inherited from
TypeSafePluginInterface.version
Defined in
packages/agents/src/abstracts/base-plugin.ts:157
enabled
• enabled: boolean
Inherited from
TypeSafePluginInterface.enabled
Defined in
packages/agents/src/abstracts/base-plugin.ts:158
category
• category: PluginCategory
Inherited from
TypeSafePluginInterface.category
Defined in
packages/agents/src/abstracts/base-plugin.ts:159
priority
• priority: number
Inherited from
TypeSafePluginInterface.priority
Defined in
packages/agents/src/abstracts/base-plugin.ts:160
Methods
initialize
▸ initialize(options?): Promise<void>
Parameters
| Name | Type |
|---|---|
options? | PluginConfig |
Returns
Promise<void>
Inherited from
TypeSafePluginInterface.initialize
Defined in
packages/agents/src/abstracts/base-plugin.ts:162
cleanup
▸ cleanup(): Promise<void>
Returns
Promise<void>
Inherited from
TypeSafePluginInterface.cleanup
Defined in
packages/agents/src/abstracts/base-plugin.ts:163
getData
▸ getData(): PluginData
Returns
Inherited from
TypeSafePluginInterface.getData
Defined in
packages/agents/src/abstracts/base-plugin.ts:164
getStats
▸ getStats(): PluginStats
Returns
Inherited from
TypeSafePluginInterface.getStats
Defined in
packages/agents/src/abstracts/base-plugin.ts:165
subscribeToModuleEvents
▸ subscribeToModuleEvents(eventEmitter): Promise<void>
Parameters
| Name | Type |
|---|---|
eventEmitter | EventEmitterPlugin |
Returns
Promise<void>
Inherited from
TypeSafePluginInterface.subscribeToModuleEvents
Defined in
packages/agents/src/abstracts/base-plugin.ts:168
unsubscribeFromModuleEvents
▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>
Parameters
| Name | Type |
|---|---|
eventEmitter | EventEmitterPlugin |
Returns
Promise<void>
Inherited from
TypeSafePluginInterface.unsubscribeFromModuleEvents
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>
Inherited from
TypeSafePluginInterface.onModuleEvent