Skip to content

LuaApiEntry ​

Type: Object

One entry of a role's ctx.* surface, for editor completions and hover

Fields ​

NameTypeArgsDescriptionDeprecated
documentationStringThe declaration's intent description, when it carries one
handleTypeStringOn a FUNCTION, the handle type the call returns; on a HANDLE_METHOD, the type it belongs to. Pair the two to resolve local d = ctx.device.get(…) and offer d:http.
isAsyncBoolean!True when the call returns (ok, res) — bind TWO values. Binding one binds the boolean.
kindLuaApiEntryKind!Whether the entry is a function, a namespace, or a handle method
pathString!Fully-qualified path, e.g. "ctx.graphql.query"
signatureString!Type signature; async functions show the (ok, res) tuple

Connect machines, automate workflows, and build custom apps for print production.