agent-core / Exports / IPlugin

Interface: IPlugin

Plugin interface extending IPluginContract

Hierarchy

• IPluginContract<IPluginConfig, IPluginStats>

  ↳ IPlugin

Table of contents

Properties

• name
• version
• enabled
• category
• priority

Methods

• initialize
• cleanup
• getData
• getStats
• subscribeToModuleEvents
• unsubscribeFromModuleEvents
• onModuleEvent

Properties

name

• name: string

Inherited from

IPluginContract.name

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:141

---

version

• version: string

Inherited from

IPluginContract.version

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:142

---

enabled

• enabled: boolean

Inherited from

IPluginContract.enabled

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:143

---

category

• category: PluginCategory

Inherited from

IPluginContract.category

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:144

---

priority

• priority: number

Inherited from

IPluginContract.priority

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:145

Methods

initialize

▸ initialize(options?): Promise<void>

Parameters

Name	Type
options?	IPluginConfig

Returns

Promise<void>

Inherited from

IPluginContract.initialize

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:146

---

cleanup

▸ cleanup(): Promise<void>

Returns

Promise<void>

Inherited from

IPluginContract.cleanup

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:147

---

getData

▸ getData(): IPluginData

Returns

IPluginData

Inherited from

IPluginContract.getData

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:148

---

getStats

▸ getStats(): IPluginStats

Returns

IPluginStats

Inherited from

IPluginContract.getStats

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>

Inherited from

IPluginContract.subscribeToModuleEvents

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>

Inherited from

IPluginContract.unsubscribeFromModuleEvents

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>

Inherited from

IPluginContract.onModuleEvent

Defined in

packages/agent-core/src/abstracts/abstract-plugin-types.ts:152