Página generada desde el TSDoc de @styx/plugin-sdk. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Interface: IPluginCopiar enlace

Un plugin Styx: manifest declarativo + lifecycle + lo que aporta.

ExtendsCopiar enlace

• IPluginLifecycle

PropertiesCopiar enlace

manifestCopiar enlace

readonly manifest: IPluginManifest

Manifest declarativo.

---

providesCopiar enlace

readonly provides: PluginExports

Implementaciones por extension point. Debe cubrir los manifest.kinds.

MethodsCopiar enlace

health()Copiar enlace

health(): Promise<Result<IPluginHealth, ResultError<"PLUGIN_HEALTH_FAILED">>>

Reporta la salud observada del plugin.

ReturnsCopiar enlace

Promise<Result<IPluginHealth, ResultError<"PLUGIN_HEALTH_FAILED">>>

Result con el health report, o PLUGIN_HEALTH_FAILED.

Inherited fromCopiar enlace

IPluginLifecycle.health

---

initialize()Copiar enlace

initialize(ctx): Promise<Result<void, ResultError<"PLUGIN_INIT_FAILED">>>

Prepara el plugin. El registry lo llama una vez al boot, con timeout.

ParametersCopiar enlace

ctxCopiar enlace

IExtensionContext

Contexto scoped (config/secrets/principal propios).

ReturnsCopiar enlace

Promise<Result<void, ResultError<"PLUGIN_INIT_FAILED">>>

Result vacío, o PLUGIN_INIT_FAILED.

Inherited fromCopiar enlace

IPluginLifecycle.initialize

---

shutdown()Copiar enlace

shutdown(): Promise<Result<void, ResultError<"PLUGIN_SHUTDOWN_FAILED">>>

Libera recursos. El registry lo llama al shutdown del servicio.

ReturnsCopiar enlace

Promise<Result<void, ResultError<"PLUGIN_SHUTDOWN_FAILED">>>

Result vacío, o PLUGIN_SHUTDOWN_FAILED.

Inherited fromCopiar enlace

IPluginLifecycle.shutdown