diff options
| -rw-r--r-- | doc/reference.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/reference.md b/doc/reference.md index 691f8f2c..e51ba57e 100644 --- a/doc/reference.md +++ b/doc/reference.md @@ -24,6 +24,7 @@ RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as de [rfc8174]: https://tools.ietf.org/html/rfc8174 - [Architecture diagram](#architecture-diagram) +- [Registry events](#registry-events) - [`PackageSpec`](#packagespec) - [`Package`](#package) - [`Package.Parse({package_identifier})`](#packageparsepackage_identifier) @@ -66,6 +67,37 @@ RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as de  +## Registry events + +The `mason-registry` Lua module extends the [EventEmitter](#eventemitter) interface and emits the following events: + +| Event | Handler signature | +| --------------------------- | ------------------------------------------ | +| `package:handle` | `fun(pkg: Package, handle: InstallHandle)` | +| `package:install:success` | `fun(pkg: Package, handle: InstallHandle)` | +| `package:install:failed` | `fun(pkg: Package, handle: InstallHandle)` | +| `package:uninstall:success` | `fun(pkg: Package)` | + +The following is an example for how to register handlers for events: + +```lua +local registry = require "mason-registry" + +registry:on( + "package:handle", + vim.schedule_wrap(function(pkg, handle) + print(string.format("Installing %s", pkg.name)) + end) +) + +registry:on( + "package:install:success", + vim.schedule_wrap(function(pkg, handle) + print(string.format("Successfully installed %s", pkg.name)) + end) +) +``` + ## `PackageSpec` **Type:** |