Zef Hemel
6078452a6c
* tpl -> template.new * define_command -> command.define * define_event_listener -> event.listen * tag -> index.tag Updated in the docs
43 lines
1.0 KiB
Markdown
43 lines
1.0 KiB
Markdown
# Event API
|
|
|
|
The Event API provides functions for working with SilverBullet's event bus system, allowing communication between different parts of the application.
|
|
|
|
## Event Operations
|
|
|
|
### event.listen(listener_def)
|
|
Register an event listener.
|
|
|
|
```lua
|
|
event.listen {
|
|
name = "my-event",
|
|
run = function(e)
|
|
print("Data", e.data)
|
|
end
|
|
}
|
|
```
|
|
|
|
### event.dispatch(event_name, 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_event("data.request", {id = 123}, 5000)
|
|
for _, response in ipairs(responses) do
|
|
print(response)
|
|
end
|
|
```
|
|
|
|
### event.list_events()
|
|
Lists all events currently registered (listened to) on the SilverBullet event bus.
|
|
|
|
Example:
|
|
```lua
|
|
local events = event.list_events()
|
|
for _, event_name in ipairs(events) do
|
|
print("Registered event: " .. event_name)
|
|
end
|
|
``` |