SDK y paquetes@styx/plugin-sdkinterfaces

Interface: IPluginLifecycle

Referencia de @styx/plugin-sdk generada de su TSDoc.

ImplementadoSin versión del tren todavía· generada desde packages/plugin-sdk/package.json

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: IPluginLifecycle

Lifecycle mínimo que todo plugin implementa (r48 §3.2) — aunque hoy sólo se llame al boot del servicio.

Extended by

Methods

health()

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

Reporta la salud observada del plugin.

Returns

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

Result con el health report, o PLUGIN_HEALTH_FAILED.


initialize()

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

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

Parameters

ctx

IExtensionContext

Contexto scoped (config/secrets/principal propios).

Returns

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

Result vacío, o PLUGIN_INIT_FAILED.


shutdown()

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

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

Returns

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

Result vacío, o PLUGIN_SHUTDOWN_FAILED.