agent-core / Exports / IPluginContract
Interface: IPluginContract<TOptions, TStats>
Type-safe plugin interface with specific type parameters
Type parameters
| Name | Type |
|---|---|
TOptions | extends IPluginOptions = IPluginOptions |
TStats | IPluginStats |
Hierarchy
IPluginContract↳
IPlugin
Implemented by
Table of contents
Properties
Methods
Properties
name
• name: string
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:141
version
• version: string
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:142
enabled
• enabled: boolean
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:143
category
• category: PluginCategory
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:144
priority
• priority: number
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:145
Methods
initialize
▸ initialize(options?): Promise<void>
Parameters
| Name | Type |
|---|---|
options? | TOptions |
Returns
Promise<void>
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:146
cleanup
▸ cleanup(): Promise<void>
Returns
Promise<void>
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:147
getData
▸ getData(): IPluginData
Returns
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:148
getStats
▸ getStats(): TStats
Returns
TStats
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:149
subscribeToModuleEvents
▸ subscribeToModuleEvents(eventEmitter): Promise<void>
Parameters
| Name | Type |
|---|---|
eventEmitter | IEventEmitterPlugin |
Returns
Promise<void>
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:150
unsubscribeFromModuleEvents
▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>
Parameters
| Name | Type |
|---|---|
eventEmitter | IEventEmitterPlugin |
Returns
Promise<void>
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:151
onModuleEvent
▸ onModuleEvent(eventName, eventData): void | Promise<void>
Parameters
| Name | Type |
|---|---|
eventName | TEventName |
eventData | IEventEmitterEventData |
Returns
void | Promise<void>
Defined in
packages/agent-core/src/abstracts/abstract-plugin-types.ts:152