From d4d93bfd391df5a0062b48557fb436985bce8648 Mon Sep 17 00:00:00 2001 From: reverse Date: Sat, 20 Jun 2026 07:51:59 +0000 Subject: [PATCH] docs: document Orbit.apiVersion in the plugin API reference --- docs/plugins.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/plugins.md b/docs/plugins.md index c1745b4..c7bba70 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -51,6 +51,7 @@ instead. See **[Compiled plugins](https://orbit.tchatou.fr/docs/compiled-plugins | Member | Description | |---|---| | `Orbit.version` / `Orbit.commit` | app version + git commit (build-time) | +| `Orbit.apiVersion` | plugin API contract version (bumped on breaking changes) — guard with `if (Orbit.apiVersion < N) …` | | `Orbit.plugin(name, fn)` | register a plugin; `fn(orbit, log)` | | `Orbit.on/once/off/emit(event, …)` | the app event bus | | `Orbit.config()` | the resolved runtime config |