Referencia de @styx/plugin-sdk generada de su TSDoc.
packages/plugin-sdk/package.jsonPágina generada desde
el TSDoc de @styx/plugin-sdk. No se edita a mano:bun run docs:genla regenera ybun run docs:checkfalla si difiere.
Lifecycle mínimo que todo plugin implementa (r48 §3.2) — aunque hoy sólo se llame al boot del servicio.
health():
Promise<Result<IPluginHealth,ResultError<"PLUGIN_HEALTH_FAILED">>>
Reporta la salud observada del plugin.
Promise<Result<IPluginHealth, ResultError<"PLUGIN_HEALTH_FAILED">>>
Result con el health report, o PLUGIN_HEALTH_FAILED.
initialize(
ctx):Promise<Result<void,ResultError<"PLUGIN_INIT_FAILED">>>
Prepara el plugin. El registry lo llama una vez al boot, con timeout.
Contexto scoped (config/secrets/principal propios).
Promise<Result<void, ResultError<"PLUGIN_INIT_FAILED">>>
Result vacío, o PLUGIN_INIT_FAILED.
shutdown():
Promise<Result<void,ResultError<"PLUGIN_SHUTDOWN_FAILED">>>
Libera recursos. El registry lo llama al shutdown del servicio.
Promise<Result<void, ResultError<"PLUGIN_SHUTDOWN_FAILED">>>
Result vacío, o PLUGIN_SHUTDOWN_FAILED.