LuaApiEntry
One entry of a role's ctx.* surface, for editor completions and hover
Fields
Fully-qualified path, e.g. "ctx.graphql.query"
Whether the entry is a function, a namespace, or a handle method
Possible values (3)
FUNCTIONA callable host function
NAMESPACEA ctx.* namespace holding functions
HANDLE_METHODA method on a handle object, invoked with a colon
Type signature; async functions show the (ok, res) tuple
The declaration's intent description, when it carries one
True when the call returns (ok, res) — bind TWO values. Binding one binds the boolean.
On 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.
Referenced by (1)
Exact type SDL
"""One entry of a role's ctx.* surface, for editor completions and hover"""
type LuaApiEntry {
"""
Fully-qualified path, e.g. "ctx.graphql.query"
"""
path: String!
"""Whether the entry is a function, a namespace, or a handle method"""
kind: LuaApiEntryKind!
"""Type signature; async functions show the (ok, res) tuple"""
signature: String!
"""The declaration's intent description, when it carries one"""
documentation: String
"""
True when the call returns (ok, res) — bind TWO values. Binding one binds the boolean.
"""
isAsync: Boolean!
"""
On 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`.
"""
handleType: String
}