docs: baked a lot of API docs

This commit is contained in:
Zef Hemel
2026-08-06 14:48:21 +02:00
parent 9b4de31ca3
commit 754e8525b9
36 changed files with 4888 additions and 49 deletions
+49 -1
View File
@@ -8,4 +8,52 @@ references:
The Event API provides functions for working with SilverBullet's event bus system, allowing communication between different parts of the application.
${spacelua.renderApiDocumentation("event")}
<!--#lua spacelua.renderApiDocumentation("event") -->
## event.dispatch
`event.dispatch(eventName, data)`
Dispatches an event and collects responses from its listeners.
**Parameters:**
- `eventName` (`string`) — Event name.
- `data` — Event payload.
**Returns:**
- `table` — Listener responses.
**Example:**
```lua
local responses = event.dispatch("data.request", {id = 123})
```
## event.listEvents
`event.listEvents()`
Lists all event names that currently have listeners.
**Returns:**
- `table` — Registered event names.
## event.listen
`event.listen(listener)`
Registers a Space Lua listener on the event bus.
**Parameters:**
- `listener` (`table`) — Listener definition with name and run callback.
**Example:**
```lua
event.listen { name = "my-event", run = function(e) print(e.data) end }
```
<!--/lua-->