Skip to content

workflow / Exports / PluginManager

Interface: PluginManager

Plugin manager interface

Table of contents

Methods

Methods

register

register(plugin): Promise<PluginValidationResult>

Register a plugin

Parameters

NameType
pluginWorkflowPlugin

Returns

Promise<PluginValidationResult>

Defined in

interfaces/workflow-plugin.ts:157


unregister

unregister(pluginName): Promise<boolean>

Unregister a plugin

Parameters

NameType
pluginNamestring

Returns

Promise<boolean>

Defined in

interfaces/workflow-plugin.ts:162


getPlugin

getPlugin(name): undefined | WorkflowPlugin

Get plugin by name

Parameters

NameType
namestring

Returns

undefined | WorkflowPlugin

Defined in

interfaces/workflow-plugin.ts:167


getAllPlugins

getAllPlugins(): WorkflowPlugin[]

Get all registered plugins

Returns

WorkflowPlugin[]

Defined in

interfaces/workflow-plugin.ts:172


getEnabledPlugins

getEnabledPlugins(): WorkflowPlugin[]

Get enabled plugins

Returns

WorkflowPlugin[]

Defined in

interfaces/workflow-plugin.ts:177


setPluginEnabled

setPluginEnabled(name, enabled): boolean

Enable/disable plugin

Parameters

NameType
namestring
enabledboolean

Returns

boolean

Defined in

interfaces/workflow-plugin.ts:182


configurePlugin

configurePlugin(name, config): boolean

Configure plugin

Parameters

NameType
namestring
configPluginConfig

Returns

boolean

Defined in

interfaces/workflow-plugin.ts:187


executeHook

executeHook<TInput, TOutput>(hookName, input, context): Promise<TOutput>

Execute hook for all plugins

Type parameters

Name
TInput
TOutput

Parameters

NameType
hookNamePluginLifecycle
inputTInput
contextPluginContext

Returns

Promise<TOutput>

Defined in

interfaces/workflow-plugin.ts:192


validateAllPlugins

validateAllPlugins(): PluginValidationResult[]

Validate all plugins

Returns

PluginValidationResult[]

Defined in

interfaces/workflow-plugin.ts:201


getExecutionOrder

getExecutionOrder(): WorkflowPlugin[]

Get plugin execution order based on dependencies and priorities

Returns

WorkflowPlugin[]

Defined in

interfaces/workflow-plugin.ts:206


healthCheck

healthCheck(): Promise<{ [pluginName: string]: { healthy: boolean ; message?: string ; details?: Record<string, unknown> }; }>

Plugin health check

Returns

Promise<{ [pluginName: string]: { healthy: boolean ; message?: string ; details?: Record<string, unknown> }; }>

Defined in

interfaces/workflow-plugin.ts:211


clear

clear(): void

Clear all plugins

Returns

void

Defined in

interfaces/workflow-plugin.ts:222

Released under the MIT License.