silverbullet/website/API/global.md

47 lines
910 B
Markdown
Raw Normal View History

2025-01-14 03:25:39 +08:00
These are Lua functions defined in the global namespace:
# Standard Lua
## print(...)
Prints to your log (browser or server log).
## assert(expr)
Asserts `expr` to be true otherwise raises an [[#error]]
## ipairs
## pairs
## unpack
## type
## tostring
## tonumber
## error(message)
Throw an error.
Example: `error("FAIL")`
## pcall
## xpcall
## setmetatable
## getmetatable
## rawset
# Space Lua specific
## tag(name)
Returns a given [[Objects#Tags]] as a query collection, to be queried using [[Space Lua/Lua Integrated Query]].
Example:
2025-01-15 03:26:47 +08:00
${query[[from tag("page") limit 1]]}
## tpl(template)
Returns a template function that can be used to render a template. Conventionally, a template string is put between `[==[` and `]==]` as string delimiters.
Example:
```space-lua
examples = examples or {}
examples.say_hello = tpl[==[Hello ${name}!]==]
```
And its use: ${examples.say_hello {name="Pete"}}