Repo refactor: rename "website" to "docs"

This commit is contained in:
Zef Hemel
2026-06-23 09:12:24 +02:00
parent 1b3e86d960
commit e7ccdc2883
226 changed files with 1 additions and 1 deletions
+43
View File
@@ -0,0 +1,43 @@
#api/syscall
The Event API provides functions for working with SilverBullet's event bus system, allowing communication between different parts of the application.
# API
### event.listen(listenerDef)
Register an event listener.
```lua
event.listen {
name = "my-event",
run = function(e)
print("Data", e.data)
end
}
```
### event.dispatch(eventName, data, timeout)
Triggers an event on the SilverBullet event bus. Event handlers can return values, which are accumulated and returned to the caller.
Example:
```lua
-- Simple event dispatch
event.dispatch("custom.event", {message = "Hello"})
-- Event dispatch with timeout and response handling
local responses = event.dispatch("data.request", {id = 123}, 5000)
for _, response in ipairs(responses) do
print(response)
end
```
### event.listEvents()
Lists all events currently registered (listened to) on the SilverBullet event bus.
Example:
```lua
local events = event.listEvents()
for _, eventName in ipairs(events) do
print("Registered event: " .. eventName)
end
```