agents / Exports / IPlugin

Interface: IPlugin

Plugin interface extending ITypeSafePlugin

Hierarchy

• ITypeSafePlugin<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

ITypeSafePlugin.name

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:157

---

version

• version: string

Inherited from

ITypeSafePlugin.version

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:158

---

enabled

• enabled: boolean

Inherited from

ITypeSafePlugin.enabled

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:159

---

category

• category: PluginCategory

Inherited from

ITypeSafePlugin.category

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:160

---

priority

• priority: number

Inherited from

ITypeSafePlugin.priority

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:161

Methods

initialize

▸ initialize(options?): Promise<void>

Parameters

Name	Type
options?	IPluginConfig

Returns

Promise<void>

Inherited from

ITypeSafePlugin.initialize

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:163

---

cleanup

▸ cleanup(): Promise<void>

Returns

Promise<void>

Inherited from

ITypeSafePlugin.cleanup

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:164

---

getData

▸ getData(): IPluginData

Returns

IPluginData

Inherited from

ITypeSafePlugin.getData

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:165

---

getStats

▸ getStats(): IPluginStats

Returns

IPluginStats

Inherited from

ITypeSafePlugin.getStats

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:166

---

subscribeToModuleEvents

▸ subscribeToModuleEvents(eventEmitter): Promise<void>

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

ITypeSafePlugin.subscribeToModuleEvents

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:169

---

unsubscribeFromModuleEvents

▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

ITypeSafePlugin.unsubscribeFromModuleEvents

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>

Inherited from

ITypeSafePlugin.onModuleEvent

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:171